diff --git a/.changeset/tasty-lobsters-tap.md b/.changeset/tasty-lobsters-tap.md new file mode 100644 index 0000000000..ea88b1e810 --- /dev/null +++ b/.changeset/tasty-lobsters-tap.md @@ -0,0 +1,11 @@ +--- +"@medusajs/file-local": patch +"medusa-file-minio": patch +"medusa-file-s3": patch +"@medusajs/medusa": patch +--- + +chore(@medusajs/medusa): add missing constructor to some services +fix(@medusajs/file-local): Fix argument passed to the constructor +fix(medusa-file-minio): Fix argument passed to the constructor +fix(medusa-file-s3): Fix argument passed to the constructor \ No newline at end of file diff --git a/docs-util/packages/typedoc-config/_base.js b/docs-util/packages/typedoc-config/_base.js index 9b4fc40c78..0c900b0694 100644 --- a/docs-util/packages/typedoc-config/_base.js +++ b/docs-util/packages/typedoc-config/_base.js @@ -17,6 +17,7 @@ module.exports = { excludeExternals: true, excludeReferences: true, disableSources: true, + sort: ["source-order"], validation: { notExported: false, // invalidLink: false, diff --git a/docs-util/packages/typedoc-config/_merger.js b/docs-util/packages/typedoc-config/_merger.js index 3c21892455..f7eaaa5c04 100644 --- a/docs-util/packages/typedoc-config/_merger.js +++ b/docs-util/packages/typedoc-config/_merger.js @@ -15,6 +15,7 @@ const baseSectionsOptions = { member_signature_title: false, member_signature_returns: false, title_reflectionPath: false, + member_declaration_children: false, } const modulesSectionsOptions = { @@ -104,18 +105,64 @@ module.exports = { maxLevel: 1, }, - // FULFILLMENT CONFIG - "^fulfillment": { + // FILE CONFIG + "^file": { + frontmatterData: { + displayed_sidebar: "core", + }, + }, + "^file/.*AbstractFileService": { reflectionGroups: { Properties: false, }, + reflectionDescription: `In this document, you’ll learn how to create a file service in the Medusa backend and the methods you must implement in it.`, + frontmatterData: { + displayed_sidebar: "core", + slug: "/development/file-service/create-file-service", + }, + reflectionTitle: { + fullReplacement: "How to Create a File Service", + }, + endSections: [ + `## Test Implementation + +:::note + +If you created your file service in a plugin, refer to [this guide on how to test plugins](https://docs.medusajs.com/development/plugins/create#test-your-plugin). + +::: + +After finishing your file service implementation: + +1\\. Run the \`build\` command in the root of your Medusa backend: + +\`\`\`bash npm2yarn +npm run build +\`\`\` + +2\\. Start the backend with the \`develop\` command: + +\`\`\`bash +npx medusa develop +\`\`\` + +3\\. Upload a file using the [Admin REST APIs](https://docs.medusajs.com/api/admin#uploads_postuploads) or using the Medusa admin, for example, to [upload a product's thumbnail](https://docs.medusajs.com/user-guide/products/manage#manage-thumbnails). + `, + ], + }, + + // FULFILLMENT CONFIG + "^fulfillment": { frontmatterData: { displayed_sidebar: "modules", }, maxLevel: 2, }, "^fulfillment/.*AbstractFulfillmentService": { - reflectionDescription: `In this document, you’ll learn how to create a fulfillment provider to a Medusa backend and the methods you must implement in it. If you’re unfamiliar with the Shipping architecture in Medusa, make sure to [check out the overview first](https://docs.medusajs.com/modules/carts-and-checkout/shipping).`, + reflectionGroups: { + Properties: false, + }, + reflectionDescription: `In this document, you’ll learn how to create a fulfillment provider in the Medusa backend and the methods you must implement in it. If you’re unfamiliar with the Shipping architecture in Medusa, make sure to [check out the overview first](https://docs.medusajs.com/modules/carts-and-checkout/shipping).`, frontmatterData: { displayed_sidebar: "modules", slug: "/modules/carts-and-checkout/backend/add-fulfillment-provider", @@ -123,6 +170,34 @@ module.exports = { reflectionTitle: { fullReplacement: "How to Create a Fulfillment Provider", }, + endSections: [ + `## Test Implementation + +:::note + +If you created your fulfillment provider in a plugin, refer to [this guide on how to test plugins](https://docs.medusajs.com/development/plugins/create#test-your-plugin). + +::: + +After finishing your fulfillment provider implementation: + +1\\. Run the \`build\` command in the root of your Medusa backend: + +\`\`\`bash npm2yarn +npm run build +\`\`\` + +2\\. Start the backend with the \`develop\` command: + +\`\`\`bash +npx medusa develop +\`\`\` + +3\\. Enable your fulfillment provider in one or more regions. You can do that either using the [Admin APIs](https://docs.medusajs.com/api/admin#regions_postregionsregionfulfillmentproviders) or the [Medusa Admin](https://docs.medusajs.com/user-guide/regions/providers#manage-fulfillment-providers). + +4\\. To test out your fulfillment provider implementation, create a cart and complete an order. You can do that either using the [Next.js starter](https://docs.medusajs.com/starters/nextjs-medusa-starter) or [using Medusa's APIs and clients](https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart). + `, + ], }, // INVENTORY CONFIG @@ -191,6 +266,36 @@ module.exports = { maxLevel: 3, }, + // MEDUSA CONFIG CONFIG + "^medusa_config": { + frontmatterData: { + displayed_sidebar: "core", + }, + expandMembers: true, + }, + "^medusa_config/.*ConfigModule": { + frontmatterData: { + displayed_sidebar: "core", + slug: "/development/backend/configurations", + }, + reflectionDescription: `In this document, you’ll learn how to create a file service in the Medusa backend and the methods you must implement in it. + +## Prerequisites + +This document assumes you already followed along with the [Prepare Environment documentation](https://docs.medusajs.com/development/backend/prepare-environment) and have a Medusa backend installed. + +---`, + reflectionTitle: "Configure Medusa Backend", + expandMembers: true, + expandProperties: true, + // parameterStyle: "list", + sections: { + ...baseSectionsOptions, + member_declaration_title: false, + member_declaration_children: true, + }, + }, + // MEDUSA REACT CONFIG "^medusa_react": { frontmatterData: { @@ -317,6 +422,86 @@ module.exports = { }, }, + // NOTIFICATION CONFIG + "^notification": { + frontmatterData: { + displayed_sidebar: "core", + }, + }, + "^notification/.*AbstractNotificationService": { + reflectionGroups: { + Properties: false, + }, + reflectionDescription: `In this document, you’ll learn how to create a notification provider in the Medusa backend and the methods you must implement in it. Learn more about the notification architecture in [this documentation](https://docs.medusajs.com/development/notification/overview)`, + frontmatterData: { + displayed_sidebar: "core", + slug: "/development/notification/create-notification-provider", + }, + reflectionTitle: { + fullReplacement: "How to Create a Notification Provider", + }, + endSections: [ + `## Subscribe with Loaders + +After creating your Notification Provider Service, you must create a [Loader](https://docs.medusajs.com/development/loaders/overview) that registers this Service as a notification handler of events. + +For example, to register the \`email-sender\` Notification Provider as a handler for the \`order.placed\` event, create the file \`src/loaders/notification.ts\` with the following content: + +\`\`\`ts title="src/loaders/notification.ts" +import { + MedusaContainer, + NotificationService, +} from "@medusajs/medusa" + +export default async ( + container: MedusaContainer +): Promise => { + const notificationService = container.resolve< + NotificationService + >("notificationService") + + notificationService.subscribe( + "order.placed", + "email-sender" + ) +} +\`\`\` + +This loader accesses the \`notificationService\` through the [MedusaContainer](https://docs.medusajs.com/development/fundamentals/dependency-injection). The \`notificationService\` has a \`subscribe\` method that accepts 2 parameters. The first one is the name of the event to subscribe to, and the second is the identifier of the Notification Provider that's subscribing to that event.`, + `## Test Sending a Notification + +Make sure you have an event bus module configured in your Medusa backend. You can learn more on how to do that in the [Configurations guide](https://docs.medusajs.com/development/backend/configurations#modules). + +Then: + +1\\. Run the \`build\` command in the root directory of your Medusa backend: + +\`\`\`bash npm2yarn +npm run build +\`\`\` + +2\\. Start your Medusa backend: + +\`\`\`bash npm2yarn +npx medusa develop +\`\`\` + +3\\. Place an order either using the [REST APIs](https://docs.medusajs.com/api/store) or using the [storefront](https://docs.medusajs.com/starters/nextjs-medusa-starter). + +4\\. After placing an order, you can see in your console the message “Notification Sent”. If you added your own notification sending logic, you should receive an email or alternatively the type of notification you’ve set up.`, + `## Test Resending a Notification + +To test resending a notification: + +1. Retrieve the ID of the notification you just sent using the [List Notifications API Route](https://docs.medusajs.com/api/admin#notifications_getnotifications). You can pass as a body parameter the \`to\` or \`event_name\` parameters to filter out the notification you just sent. + +2. Send a request to the [Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend) using the ID retrieved from the previous request. You can pass the \`to\` parameter in the body to change the receiver of the notification. + +3. You should see the message “Notification Resent” in your console. + `, + ], + }, + // PAYMENT CONFIG "^payment": { frontmatterData: { @@ -336,6 +521,80 @@ module.exports = { reflectionGroups: { Properties: false, }, + endSections: [ + `## Test Implementation + +:::note + +If you created your payment processor in a plugin, refer to [this guide on how to test plugins](https://docs.medusajs.com/development/plugins/create#test-your-plugin). + +::: + +After finishing your payment processor implementation: + +1\\. Run the \`build\` command in the root of your Medusa backend: + +\`\`\`bash npm2yarn +npm run build +\`\`\` + +2\\. Start the backend with the \`develop\` command: + +\`\`\`bash +npx medusa develop +\`\`\` + +3\\. Enable your payment processor in one or more regions. You can do that either using the [Admin APIs](https://docs.medusajs.com/api/admin#regions_postregionsregionpaymentproviders) or the [Medusa Admin](https://docs.medusajs.com/user-guide/regions/providers#manage-payment-providers). + +4\\. There are different ways to test out your payment processor, such as authorizing payment on order completion or capturing payment of an order. You test payment in a checkout flow either using the [Next.js starter](https://docs.medusajs.com/starters/nextjs-medusa-starter) or [using Medusa's APIs and clients](https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-checkout-flow). + `, + ], + }, + + // PRICE SELECTION CONFIG + "^price_selection": { + frontmatterData: { + displayed_sidebar: "modules", + }, + }, + "^price_selection/.*AbstractPriceSelectionStrategy": { + reflectionDescription: `In this document, you’ll learn what the price selection strategy and how to override it in the Medusa backend.`, + reflectionGroups: { + Properties: false, + }, + frontmatterData: { + displayed_sidebar: "modules", + slug: "/modules/price-lists/price-selection-strategy", + }, + reflectionTitle: { + fullReplacement: "How to Override the Price Selection Strategy", + }, + endSections: [ + `## Test Implementation + +:::note + +If you created your price selection strategy in a plugin, refer to [this guide on how to test plugins](https://docs.medusajs.com/development/plugins/create#test-your-plugin). + +::: + +After finishing your price selection strategy implementation: + +1\\. Run the \`build\` command in the root of your Medusa backend: + +\`\`\`bash npm2yarn +npm run build +\`\`\` + +2\\. Start the backend with the \`develop\` command: + +\`\`\`bash +npx medusa develop +\`\`\` + +3\\. To test out your price selection strategy implementation, you can retrieve a product and it's variants by specifying pricing parameters as explained in [this guide](https://docs.medusajs.com/modules/products/storefront/show-products#product-pricing-parameters). + `, + ], }, // PRICING CONFIG @@ -424,6 +683,62 @@ module.exports = { }, }, + // SEARCH CONFIG + "^search": { + frontmatterData: { + displayed_sidebar: "core", + }, + }, + "^search/.*AbstractSearchService": { + reflectionDescription: `In this document, you’ll learn how to create a search service in the Medusa backend and the methods you must implement in it. + +## Prerequisites + +A search service must extend the \`AbstractSearchService\` class imported from the \`@medusajs/utils\` package. If you don’t already have the package +installed, run the following command to install it within your project: + +\`\`\`bash npm2yarn +npm install @medusajs/utils +\`\`\` + +---`, + frontmatterData: { + displayed_sidebar: "core", + slug: "/development/search/create", + }, + reflectionTitle: { + fullReplacement: "How to Create a Search Service", + }, + endSections: [ + `## Test Implementation + +:::note + +If you created your search service in a plugin, refer to [this guide on how to test plugins](https://docs.medusajs.com/development/plugins/create#test-your-plugin). + +::: + +After finishing your search service implementation: + +1\\. Make sure you have an [event bus module](https://docs.medusajs.com/development/events/modules/redis) installed that triggers search indexing when the Medusa backend loads. + +2\\. Run the \`build\` command in the root of your Medusa backend: + +\`\`\`bash npm2yarn +npm run build +\`\`\` + +3\\. Start the backend with the \`develop\` command: + +\`\`\`bash +npx medusa develop +\`\`\` + +4\\. Try to search for products either using the [Search Products API Route](https://docs.medusajs.com/api/store#products_postproductssearch). The results returned by your search service's \`search\` method is returned in the \`hits\` response field. + `, + ], + }, + // SERVICES CONFIG "^services": { frontmatterData: { @@ -467,6 +782,100 @@ module.exports = { }, }, + // TAX CALCULATION CONFIG + "^tax_calculation": { + frontmatterData: { + displayed_sidebar: "modules", + }, + }, + "^tax_calculation/.*AbstractTaxCalculationStrategy": { + reflectionGroups: { + Properties: false, + }, + reflectionDescription: `In this document, you’ll learn how to override the tax calculations strategy in the Medusa backend and the methods you must implement in it.`, + frontmatterData: { + displayed_sidebar: "modules", + slug: "/modules/taxes/backend/tax-calculation-strategy", + }, + reflectionTitle: { + fullReplacement: "How to Override a Tax Calculation Strategy", + }, + endSections: [ + `## Test Implementation + +:::note + +If you created your tax calculation strategy in a plugin, refer to [this guide on how to test plugins](https://docs.medusajs.com/development/plugins/create#test-your-plugin). + +::: + +After finishing your tax calculation strategy implementation: + +1\\. Run the \`build\` command in the root of your Medusa backend: + +\`\`\`bash npm2yarn +npm run build +\`\`\` + +2\\. Start the backend with the \`develop\` command: + +\`\`\`bash +npx medusa develop +\`\`\` + +3\\. To test out your tax calculation strategy implementation, you can [trigger taxes calculation manually](https://docs.medusajs.com/modules/taxes/storefront/manual-calculation). + `, + ], + }, + + // TAX PROVIDER CONFIG + "^tax/": { + frontmatterData: { + displayed_sidebar: "modules", + }, + }, + "^tax/.*AbstractTaxService": { + reflectionGroups: { + Properties: false, + }, + reflectionDescription: `In this document, you’ll learn how to create a tax provider in the Medusa backend and the methods you must implement in it.`, + frontmatterData: { + displayed_sidebar: "modules", + slug: "/modules/taxes/backend/create-tax-provider", + }, + reflectionTitle: { + fullReplacement: "How to Create a Tax Provider", + }, + endSections: [ + `## Test Implementation + +:::note + +If you created your tax provider in a plugin, refer to [this guide on how to test plugins](https://docs.medusajs.com/development/plugins/create#test-your-plugin). + +::: + +After finishing your tax provider implementation: + +1\\. Run the \`build\` command in the root of your Medusa backend: + +\`\`\`bash npm2yarn +npm run build +\`\`\` + +2\\. Start the backend with the \`develop\` command: + +\`\`\`bash +npx medusa develop +\`\`\` + +3\\. Use the tax provider in a region. You can do that either using the [Admin APIs](https://docs.medusajs.com/modules/taxes/admin/manage-tax-settings#change-tax-provider-of-a-region) or the [Medusa Admin](https://docs.medusajs.com/user-guide/taxes/manage#change-tax-provider). + +4\\. To test out your tax provider implementation, you can [trigger taxes calculation manually](https://docs.medusajs.com/modules/taxes/storefront/manual-calculation). + `, + ], + }, + // WORKFLOWS CONFIG "^workflows": { expandMembers: true, diff --git a/docs-util/packages/typedoc-config/extended-tsconfig/utils.json b/docs-util/packages/typedoc-config/extended-tsconfig/utils.json new file mode 100644 index 0000000000..cf6d7138f3 --- /dev/null +++ b/docs-util/packages/typedoc-config/extended-tsconfig/utils.json @@ -0,0 +1,6 @@ +{ + "$schema": "http://json.schemastore.org/tsconfig", + "extends": [ + "../../../../packages/utils/tsconfig.json" + ] +} \ No newline at end of file diff --git a/docs-util/packages/typedoc-config/file.js b/docs-util/packages/typedoc-config/file.js new file mode 100644 index 0000000000..9c11066c2e --- /dev/null +++ b/docs-util/packages/typedoc-config/file.js @@ -0,0 +1,9 @@ +/* eslint-disable @typescript-eslint/no-var-requires */ +const getConfig = require("./utils/get-config") + +module.exports = getConfig({ + entryPointPath: "packages/medusa/src/interfaces/file-service.ts", + tsConfigName: "medusa.json", + name: "file", + parentIgnore: true, +}) diff --git a/docs-util/packages/typedoc-config/medusa-config.js b/docs-util/packages/typedoc-config/medusa-config.js new file mode 100644 index 0000000000..fced82620f --- /dev/null +++ b/docs-util/packages/typedoc-config/medusa-config.js @@ -0,0 +1,8 @@ +/* eslint-disable @typescript-eslint/no-var-requires */ +const getConfig = require("./utils/get-config") + +module.exports = getConfig({ + entryPointPath: "packages/types/src/common/config-module.ts", + tsConfigName: "types.json", + name: "medusa-config", +}) diff --git a/docs-util/packages/typedoc-config/notification.js b/docs-util/packages/typedoc-config/notification.js new file mode 100644 index 0000000000..299e72d235 --- /dev/null +++ b/docs-util/packages/typedoc-config/notification.js @@ -0,0 +1,9 @@ +/* eslint-disable @typescript-eslint/no-var-requires */ +const getConfig = require("./utils/get-config") + +module.exports = getConfig({ + entryPointPath: "packages/medusa/src/interfaces/notification-service.ts", + tsConfigName: "medusa.json", + name: "notification", + parentIgnore: true, +}) diff --git a/docs-util/packages/typedoc-config/price-selection.js b/docs-util/packages/typedoc-config/price-selection.js new file mode 100644 index 0000000000..b572e60f25 --- /dev/null +++ b/docs-util/packages/typedoc-config/price-selection.js @@ -0,0 +1,9 @@ +/* eslint-disable @typescript-eslint/no-var-requires */ +const getConfig = require("./utils/get-config") + +module.exports = getConfig({ + entryPointPath: "packages/medusa/src/interfaces/price-selection-strategy.ts", + tsConfigName: "medusa.json", + name: "price-selection", + parentIgnore: true, +}) diff --git a/docs-util/packages/typedoc-config/search.js b/docs-util/packages/typedoc-config/search.js new file mode 100644 index 0000000000..0535444228 --- /dev/null +++ b/docs-util/packages/typedoc-config/search.js @@ -0,0 +1,8 @@ +/* eslint-disable @typescript-eslint/no-var-requires */ +const getConfig = require("./utils/get-config") + +module.exports = getConfig({ + entryPointPath: "packages/utils/src/search/abstract-service.ts", + tsConfigName: "utils.json", + name: "search", +}) diff --git a/docs-util/packages/typedoc-config/tax-calculation.js b/docs-util/packages/typedoc-config/tax-calculation.js new file mode 100644 index 0000000000..717a30830c --- /dev/null +++ b/docs-util/packages/typedoc-config/tax-calculation.js @@ -0,0 +1,9 @@ +/* eslint-disable @typescript-eslint/no-var-requires */ +const getConfig = require("./utils/get-config") + +module.exports = getConfig({ + entryPointPath: "packages/medusa/src/interfaces/tax-calculation-strategy.ts", + tsConfigName: "medusa.json", + name: "tax-calculation", + parentIgnore: true, +}) diff --git a/docs-util/packages/typedoc-config/tax.js b/docs-util/packages/typedoc-config/tax.js new file mode 100644 index 0000000000..98d0ee5ecc --- /dev/null +++ b/docs-util/packages/typedoc-config/tax.js @@ -0,0 +1,9 @@ +/* eslint-disable @typescript-eslint/no-var-requires */ +const getConfig = require("./utils/get-config") + +module.exports = getConfig({ + entryPointPath: "packages/medusa/src/interfaces/tax-service.ts", + tsConfigName: "medusa.json", + name: "tax", + parentIgnore: true, +}) diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts index c6cfe87a84..564203a3d0 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/render-utils.ts @@ -16,7 +16,7 @@ import ifShowReturnsHelper from "./resources/helpers/if-show-returns" import ifShowTypeHierarchyHelper from "./resources/helpers/if-show-type-hierarchy" import indexSignatureTitleHelper from "./resources/helpers/index-signature-title" import parameterTableHelper from "./resources/helpers/parameter-table" -import objectLiteralMemberHelper from "./resources/helpers/type-declaration-object-literal" +import objectLiteralMemberHelper from "./resources/helpers/type-declaration-members" import referenceMember from "./resources/helpers/reference-member" import reflectionPathHelper from "./resources/helpers/reflection-path" import reflectionTitleHelper from "./resources/helpers/reflection-title" @@ -58,6 +58,11 @@ import ifHasMutationReturnHelper from "./resources/helpers/if-has-mutation-retur import reactQueryMutationReturnHelper from "./resources/helpers/react-query-mutation-return" import ifHasQueryReturnHelper from "./resources/helpers/if-has-query-return" import reactQueryQueryReturnHelper from "./resources/helpers/react-query-query-return" +import endSectionsHelper from "./resources/helpers/end-sections" +import getDeclarationChildrenHelper from "./resources/helpers/get-declaration-children" +import ifShowSeparatorForTitleLevelHelper from "./resources/helpers/if-show-separator-for-title-level" +import shouldExpandPropertiesHelper from "./resources/helpers/should-expand-properties" +import shouldExpandDeclarationChildrenHelper from "./resources/helpers/should-expand-declaration-children" import { MarkdownTheme } from "./theme" const TEMPLATE_PATH = path.join(__dirname, "resources", "templates") @@ -144,4 +149,9 @@ export function registerHelpers(theme: MarkdownTheme) { reactQueryMutationReturnHelper(theme) ifHasQueryReturnHelper(theme) reactQueryQueryReturnHelper(theme) + endSectionsHelper(theme) + getDeclarationChildrenHelper(theme) + ifShowSeparatorForTitleLevelHelper(theme) + shouldExpandPropertiesHelper(theme) + shouldExpandDeclarationChildrenHelper(theme) } diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/declaration-title.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/declaration-title.ts index fc0f169ac6..f26e17c5a5 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/declaration-title.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/declaration-title.ts @@ -55,6 +55,7 @@ export default function (theme: MarkdownTheme) { ` = \`${stripLineBreaks(stripComments(`${this.defaultValue}`))}\`` ) } + return md.join("") } ) diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/end-sections.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/end-sections.ts new file mode 100644 index 0000000000..21e774f8d0 --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/end-sections.ts @@ -0,0 +1,17 @@ +import * as Handlebars from "handlebars" +import { MarkdownTheme } from "../../theme" + +export default function (theme: MarkdownTheme) { + Handlebars.registerHelper("endSections", function () { + const { endSections } = theme.getFormattingOptionsForLocation() + + if (!endSections?.length) { + return "" + } + + const lineBreaks = "\n\n" + const separator = `---${lineBreaks}` + + return `${separator}${endSections.join(`${lineBreaks}${separator}`)}` + }) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/get-declaration-children.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/get-declaration-children.ts new file mode 100644 index 0000000000..3b245ddfef --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/get-declaration-children.ts @@ -0,0 +1,26 @@ +import * as Handlebars from "handlebars" +import { DeclarationReflection } from "typedoc" +import { getTypeChildren } from "utils" +import { MarkdownTheme } from "../../theme" + +export default function (theme: MarkdownTheme) { + Handlebars.registerHelper( + "getDeclarationChildren", + function (this: DeclarationReflection) { + const { maxLevel } = theme.getFormattingOptionsForLocation() + + if (!this.children && !this.type) { + return [] + } + + return ( + this.children || + getTypeChildren({ + reflectionType: this.type!, + project: this.project, + maxLevel, + }) + ) + } + ) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-show-separator-for-title-level.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-show-separator-for-title-level.ts new file mode 100644 index 0000000000..bae0ed0dd8 --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/if-show-separator-for-title-level.ts @@ -0,0 +1,13 @@ +import * as Handlebars from "handlebars" +import { MarkdownTheme } from "../../theme" + +export default function (theme: MarkdownTheme) { + Handlebars.registerHelper( + "ifShowSeparatorForTitleLevel", + function (this: unknown, options: Handlebars.HelperOptions) { + const { currentTitleLevel } = theme + + return currentTitleLevel <= 2 ? options.fn(this) : options.inverse(this) + } + ) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/should-expand-declaration-children.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/should-expand-declaration-children.ts new file mode 100644 index 0000000000..df1911aa3e --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/should-expand-declaration-children.ts @@ -0,0 +1,11 @@ +import * as Handlebars from "handlebars" +import { MarkdownTheme } from "../../theme" + +export default function (theme: MarkdownTheme) { + Handlebars.registerHelper("shouldExpandDeclarationChildren", function () { + const { currentTitleLevel } = theme + const { expandMembers } = theme.getFormattingOptionsForLocation() + + return expandMembers && currentTitleLevel <= 3 + }) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/should-expand-properties.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/should-expand-properties.ts new file mode 100644 index 0000000000..c44629c3fa --- /dev/null +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/should-expand-properties.ts @@ -0,0 +1,11 @@ +import * as Handlebars from "handlebars" +import { MarkdownTheme } from "../../theme" + +export default function (theme: MarkdownTheme) { + Handlebars.registerHelper("shouldExpandProperties", function (title: string) { + const { currentTitleLevel } = theme + const { expandProperties = false } = theme.getFormattingOptionsForLocation() + + return title === "Properties" && expandProperties && currentTitleLevel <= 3 + }) +} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/show-properties-as-component.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/show-properties-as-component.ts index 3dccec3c94..1340a1d3d3 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/show-properties-as-component.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/show-properties-as-component.ts @@ -7,8 +7,6 @@ export default function (theme: MarkdownTheme) { function (title: string) { const { parameterStyle } = theme.getFormattingOptionsForLocation() - // console.log(parameterStyle, title) - return parameterStyle === "component" && title === "Properties" } ) diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/type-declaration-object-literal.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/type-declaration-members.ts similarity index 100% rename from docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/type-declaration-object-literal.ts rename to docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/type-declaration-members.ts diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.declaration.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.declaration.hbs index 1b4eb4b2b9..75266568e9 100755 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.declaration.hbs +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.declaration.hbs @@ -86,7 +86,7 @@ {{#with type.declaration}} -{{{titleLevel}}} Type declaration +{{{titleLevel}}} Properties {{/with}} @@ -102,4 +102,28 @@ {{/if}} +{{#if (sectionEnabled "member_declaration_children")}} + +{{#if (shouldExpandDeclarationChildren)}} + +{{#each (getDeclarationChildren)}} + +{{> member}} + +{{/each}} + +{{else}} + +{{#with (getDeclarationChildren)}} + +{{{titleLevel}}} Properties + +{{{typeDeclarationMembers}}} + +{{/with}} + +{{/if}} + +{{/if}} + {{> member.sources}} \ No newline at end of file diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.hbs index 630d4ed779..e49aa45509 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.hbs +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/member.hbs @@ -56,14 +56,6 @@ {{/if}} -{{#unless @last}} -{{#unless hasOwnDocument}} -{{#unless removeSeparator}} -___ -{{/unless}} -{{/unless}} -{{/unless}} - {{#unless hasOwnDocument}} {{#if name}} @@ -72,4 +64,14 @@ ___ {{/if}} -{{/unless}} \ No newline at end of file +{{/unless}} + +{{#ifShowSeparatorForTitleLevel}} +{{#unless @last}} +{{#unless hasOwnDocument}} +{{#unless removeSeparator}} +___ +{{/unless}} +{{/unless}} +{{/unless}} +{{/ifShowSeparatorForTitleLevel}} \ No newline at end of file diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/members.group.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/members.group.hbs index 9363f01221..b5916ed434 100755 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/members.group.hbs +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/members.group.hbs @@ -4,9 +4,11 @@ {{#each categories}} +{{#ifShowSeparatorForTitleLevel}} {{#unless @first}} ___ {{/unless}} +{{/ifShowSeparatorForTitleLevel}} {{#unless (getFormattingOption "expandMembers")}} @@ -20,7 +22,15 @@ ___ {{/unless}} -{{#if (showPropertiesAsComponent title)}} +{{#if (shouldExpandProperties title)}} + +{{#each children}} + +{{> member }} + +{{/each}} + +{{else if (showPropertiesAsComponent title)}} {{#with children}} @@ -64,7 +74,15 @@ ___ {{/unless}} -{{#if (showPropertiesAsComponent title)}} +{{#if (shouldExpandProperties title)}} + +{{#each children}} + +{{> member }} + +{{/each}} + +{{else if (showPropertiesAsComponent title)}} {{#with children}} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/members.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/members.hbs index 4625f906df..8bcf083236 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/members.hbs +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/partials/members.hbs @@ -4,9 +4,11 @@ {{#each categories}} +{{#ifShowSeparatorForTitleLevel}} {{#unless @first}} ___ {{/unless}} +{{/ifShowSeparatorForTitleLevel}} {{#unless allChildrenHaveOwnDocument}} @@ -44,9 +46,11 @@ ___ {{#unless allChildrenHaveOwnDocument}} +{{#ifShowSeparatorForTitleLevel}} {{#unless @first}} ___ {{/unless}} +{{/ifShowSeparatorForTitleLevel}} {{> members.group}} diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/templates/index.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/templates/index.hbs index c392fefe55..fc41b15f9c 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/templates/index.hbs +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/templates/index.hbs @@ -7,3 +7,5 @@ {{{comment this}}} {{/with}} + +{{{ endSections }}} \ No newline at end of file diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/templates/reflection.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/templates/reflection.hbs index f716dfc8ac..aeefbeaa80 100755 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/templates/reflection.hbs +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/templates/reflection.hbs @@ -144,4 +144,6 @@ {{> main}} -{{/with}} \ No newline at end of file +{{/with}} + +{{{ endSections }}} \ No newline at end of file diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/templates/reflection.member.hbs b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/templates/reflection.member.hbs index 8cfcc17b9d..03354e0073 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/templates/reflection.member.hbs +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/resources/templates/reflection.member.hbs @@ -11,3 +11,5 @@ {{decrementCurrentTitleLevel}} {{/with}} + +{{{ endSections }}} \ No newline at end of file diff --git a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-type-parameters.ts b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-type-parameters.ts index e56b6dca81..25ce3ae8a4 100644 --- a/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-type-parameters.ts +++ b/docs-util/packages/typedoc-plugin-markdown-medusa/src/utils/reflection-type-parameters.ts @@ -31,7 +31,7 @@ export function getReflectionTypeParameters({ comment, level = 1, maxLevel, - wrapObject = false, + wrapObject, isReturn = true, }: GetReflectionTypeParametersParams): Parameter[] { const typeName = getType({ @@ -52,6 +52,20 @@ export function getReflectionTypeParameters({ }) const formatParameter = () => { + let description = "" + + if (comment) { + if (isReturn) { + description = getReturnComment(comment) + } + + if (!description.length) { + description = Handlebars.helpers.comment(comment.summary) + } + } else if (!isReturn) { + description = loadComment(typeName, project) + } + return { name: "name" in reflectionType ? reflectionType.name : typeName, type, @@ -65,13 +79,7 @@ export function getReflectionTypeParameters({ reflectionType.declaration as DeclarationReflection ) || "" : "", - description: comment - ? isReturn - ? getReturnComment(comment) - : Handlebars.helpers.comment(comment.summary) - : !comment && !isReturn - ? loadComment(typeName, project) - : "", + description, expandable: comment?.hasModifier(`@expandable`) || false, featureFlag: Handlebars.helpers.featureFlag(comment), children: [], @@ -99,20 +107,25 @@ export function getReflectionTypeParameters({ if (!reflectionTypeArg) { return } - const typeArgComponent = getReflectionTypeParameters({ - reflectionType: reflectionTypeArg, - project, - level: level + 1, - maxLevel, - }) - componentItem[parentKey - 1].children?.push(...typeArgComponent) + componentItem[parentKey - 1].children?.push( + ...getReflectionTypeParameters({ + reflectionType: reflectionTypeArg, + project, + level: level + 1, + maxLevel, + isReturn: false, + }) + ) }) } } else { const reflection = (reflectionType.reflection || getProjectChild(project, reflectionType.name)) as DeclarationReflection - const parentKey = wrapObject + const shouldWrapObject = + wrapObject || + (wrapObject === undefined && level > 1 && canRetrieveChildren) + const parentKey = shouldWrapObject ? componentItem.push(formatParameter()) : undefined if (reflection) { @@ -149,10 +162,8 @@ export function getReflectionTypeParameters({ ? componentItem[parentKey - 1].children?.push(childParameter) : componentItem.push(childParameter) } - } else { - parentKey - ? componentItem[parentKey - 1].children?.push(formatParameter()) - : componentItem.push(formatParameter()) + } else if (!parentKey) { + componentItem.push(formatParameter()) } } } else if (reflectionType.type === "array") { @@ -163,6 +174,7 @@ export function getReflectionTypeParameters({ project, level: level + 1, maxLevel, + isReturn: false, }) componentItem[parentKey - 1].children?.push(...elementTypeItem) } @@ -186,6 +198,7 @@ export function getReflectionTypeParameters({ project, level: level + 1, maxLevel, + isReturn: false, }) pushTo.push(...elementTypeItem) }) @@ -200,6 +213,7 @@ export function getReflectionTypeParameters({ project, level: level + 1, maxLevel, + isReturn: false, }) parentKey diff --git a/docs-util/packages/types/lib/index.d.ts b/docs-util/packages/types/lib/index.d.ts index c1c4c98bdc..b4bc846124 100644 --- a/docs-util/packages/types/lib/index.d.ts +++ b/docs-util/packages/types/lib/index.d.ts @@ -62,6 +62,7 @@ export type FormattingOptionType = { } reflectionDescription?: string expandMembers?: boolean + expandProperties?: boolean showCommentsAsHeader?: boolean showCommentsAsDetails?: boolean parameterStyle?: ParameterStyle @@ -71,6 +72,7 @@ export type FormattingOptionType = { mdxImports?: string[] maxLevel?: number fileNameSeparator?: string + endSections?: string[] } export declare module "typedoc" { diff --git a/docs-util/typedoc-json-output/0-medusa.json b/docs-util/typedoc-json-output/0-medusa.json index 3fb99dccaa..34900a90eb 100644 --- a/docs-util/typedoc-json-output/0-medusa.json +++ b/docs-util/typedoc-json-output/0-medusa.json @@ -6,7 +6,582 @@ "flags": {}, "children": [ { - "id": 4905, + "id": 4819, + "name": "MedusaError", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Standardized error to be used across Medusa project." + } + ] + }, + "children": [ + { + "id": 4842, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4843, + "name": "message", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "overwrites": { + "type": "reference", + "target": -1, + "name": "Error.message" + } + }, + { + "id": 4844, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4845, + "name": "date", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 4820, + "name": "Types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isStatic": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 4821, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4822, + "name": "DB_ERROR", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Errors stemming from the database" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4823, + "name": "DUPLICATE_ERROR", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4824, + "name": "INVALID_ARGUMENT", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4825, + "name": "INVALID_DATA", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4826, + "name": "UNAUTHORIZED", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4827, + "name": "NOT_FOUND", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4828, + "name": "NOT_ALLOWED", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4829, + "name": "UNEXPECTED_STATE", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4830, + "name": "CONFLICT", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4831, + "name": "PAYMENT_AUTHORIZATION_ERROR", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4822, + 4823, + 4824, + 4825, + 4826, + 4827, + 4828, + 4829, + 4830, + 4831 + ] + } + ] + } + } + }, + { + "id": 4832, + "name": "Codes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isStatic": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 4833, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4834, + "name": "INSUFFICIENT_INVENTORY", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4835, + "name": "CART_INCOMPATIBLE_STATE", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4834, + 4835 + ] + } + ] + } + } + }, + { + "id": 4836, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4837, + "name": "new MedusaError", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Creates a standardized error to be used across Medusa project." + } + ] + }, + "parameters": [ + { + "id": 4838, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "type of error" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4839, + "name": "message", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "message to go along with error" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4840, + "name": "code", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "code of error" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4841, + "name": "params", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "params" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "target": 4819, + "name": "MedusaError", + "package": "medusa-core-utils" + }, + "overwrites": { + "type": "reference", + "target": -1, + "name": "Error.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": -1, + "name": "Error.constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4836 + ] + }, + { + "title": "Properties", + "children": [ + 4842, + 4843, + 4844, + 4845, + 4820, + 4832 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Error" + }, + "name": "Error", + "package": "typescript" + } + ] + }, + { + "id": 4883, + "name": "MedusaContainer", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/awilix/lib/container.d.ts", + "qualifiedName": "AwilixContainer" + }, + "name": "AwilixContainer", + "package": "awilix" + }, + { + "type": "reflection", + "declaration": { + "id": 4884, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4885, + "name": "registerAdd", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4886, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4887, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "typeParameter": [ + { + "id": 4890, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 4888, + "name": "name", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4889, + "name": "registration", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4890, + "name": "T", + "package": "medusa-core-utils", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": 4883, + "name": "MedusaContainer", + "package": "medusa-core-utils" + } + } + ] + } + } + }, + { + "id": 4891, + "name": "createScope", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4892, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4893, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reference", + "target": 4883, + "name": "MedusaContainer", + "package": "medusa-core-utils" + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4885, + 4891 + ] + } + ] + } + } + ] + } + }, + { + "id": 4894, "name": "\"medusa-interfaces\"", "variant": "declaration", "kind": 4, @@ -14,1480 +589,183 @@ "implementedBy": [ { "type": "reference", - "target": 3456, + "target": 3462, "name": "AbstractPaymentService" } ] }, { - "id": 3798, - "name": "BatchJobStatus", + "id": 2624, + "name": "authenticateCustomer", "variant": "declaration", - "kind": 8, + "kind": 64, "flags": {}, - "children": [ + "signatures": [ { - "id": 3804, - "name": "CANCELED", - "variant": "declaration", - "kind": 16, + "id": 2625, + "name": "authenticateCustomer", + "variant": "signature", + "kind": 4096, "flags": {}, "type": { - "type": "literal", - "value": "canceled" - } - }, - { - "id": 3803, - "name": "COMPLETED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "completed" - } - }, - { - "id": 3801, - "name": "CONFIRMED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "confirmed" - } - }, - { - "id": 3799, - "name": "CREATED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "created" - } - }, - { - "id": 3805, - "name": "FAILED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "failed" - } - }, - { - "id": 3800, - "name": "PRE_PROCESSED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "pre_processed" - } - }, - { - "id": 3802, - "name": "PROCESSING", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "processing" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 3804, - 3803, - 3801, - 3799, - 3805, - 3800, - 3802 - ] - } - ] - }, - { - "id": 4916, - "name": "DefaultPriceType", - "variant": "declaration", - "kind": 8, - "flags": {} - }, - { - "id": 5219, - "name": "MODULE_RESOURCE_TYPE", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 5221, - "name": "ISOLATED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "isolated" - } - }, - { - "id": 5220, - "name": "SHARED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "shared" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 5221, - 5220 - ] - } - ] - }, - { - "id": 4239, - "name": "PostgresError", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 4240, - "name": "DUPLICATE_ERROR", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "23505" - } - }, - { - "id": 4241, - "name": "FOREIGN_KEY_ERROR", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "23503" - } - }, - { - "id": 4243, - "name": "NULL_VIOLATION", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "23502" - } - }, - { - "id": 4242, - "name": "SERIALIZATION_FAILURE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "40001" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 4240, - 4241, - 4243, - 4242 - ] - } - ] - }, - { - "id": 4064, - "name": "PriceListStatus", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The status of a price list." - } - ] - }, - "children": [ - { - "id": 4065, - "name": "ACTIVE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.RequestHandler" + }, + "typeArguments": [ { - "kind": "text", - "text": "The price list is active, meaning its prices are applied to customers." - } - ] - }, - "type": { - "type": "literal", - "value": "active" - } - }, - { - "id": 4066, - "name": "DRAFT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", + "qualifiedName": "ParamsDictionary" + }, + "name": "ParamsDictionary", + "package": "@types/express-serve-static-core" + }, { - "kind": "text", - "text": "The price list is a draft, meaning its not yet applied to customers." - } - ] - }, - "type": { - "type": "literal", - "value": "draft" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 4065, - 4066 - ] - } - ] - }, - { - "id": 4536, - "name": "PriceListStatus", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 4537, - "name": "ACTIVE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "active" - } - }, - { - "id": 4538, - "name": "DRAFT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "draft" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 4537, - 4538 - ] - } - ] - }, - { - "id": 4061, - "name": "PriceListType", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of price list." - } - ] - }, - "children": [ - { - "id": 4063, - "name": "OVERRIDE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ + "type": "intrinsic", + "name": "any" + }, { - "kind": "text", - "text": "The price list is used to override original prices for specific conditions." - } - ] - }, - "type": { - "type": "literal", - "value": "override" - } - }, - { - "id": 4062, - "name": "SALE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ + "type": "intrinsic", + "name": "any" + }, { - "kind": "text", - "text": "The price list is used for a sale." - } - ] - }, - "type": { - "type": "literal", - "value": "sale" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 4063, - 4062 - ] - } - ] - }, - { - "id": 4539, - "name": "PriceListType", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 4541, - "name": "OVERRIDE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "override" - } - }, - { - "id": 4540, - "name": "SALE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "sale" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 4541, - 4540 - ] - } - ] - }, - { - "id": 5243, - "name": "ProductStatus", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 5244, - "name": "DRAFT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "draft" - } - }, - { - "id": 5245, - "name": "PROPOSED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "proposed" - } - }, - { - "id": 5246, - "name": "PUBLISHED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "published" - } - }, - { - "id": 5247, - "name": "REJECTED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "rejected" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 5244, - 5245, - 5246, - 5247 - ] - } - ] - }, - { - "id": 4915, - "name": "DEFAULT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "default" - } - }, - { - "id": 5234, - "name": "EXTERNAL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "external" - } - }, - { - "id": 5218, - "name": "INTERNAL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "internal" - } - }, - { - "id": 2748, - "name": "AbstractBatchJobStrategy", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 2755, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2756, - "name": "new AbstractBatchJobStrategy", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 2757, - "name": "__container__", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", + "qualifiedName": "QueryString.ParsedQs" + }, + "name": "ParsedQs", + "package": "@types/qs", + "qualifiedName": "QueryString.ParsedQs" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { "type": "intrinsic", "name": "any" } - }, - { - "id": 2758, - "name": "__configModule__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2759, - "name": "__moduleDeclaration__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": 2748, - "name": "AbstractBatchJobStrategy", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3762, - "name": "TransactionBaseService.constructor" + ], + "name": "Record", + "package": "typescript" } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3761, - "name": "TransactionBaseService.constructor" + ], + "name": "RequestHandler", + "package": "@types/express", + "qualifiedName": "e.RequestHandler" } - }, + } + ] + }, + { + "id": 2622, + "name": "authenticate", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ { - "id": 2788, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, + "id": 2623, + "name": "authenticate", + "variant": "signature", + "kind": 4096, + "flags": {}, "type": { "type": "reference", "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.RequestHandler" }, "typeArguments": [ { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", + "qualifiedName": "ParamsDictionary" + }, + "name": "ParamsDictionary", + "package": "@types/express-serve-static-core" }, { "type": "intrinsic", - "name": "unknown" + "name": "any" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", + "qualifiedName": "QueryString.ParsedQs" + }, + "name": "ParsedQs", + "package": "@types/qs", + "qualifiedName": "QueryString.ParsedQs" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" } ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - }, - "implementationOf": { - "type": "reference", - "target": 2722, - "name": "IBatchJobStrategy.__configModule__" + "name": "RequestHandler", + "package": "@types/express", + "qualifiedName": "e.RequestHandler" } - }, - { - "id": 2787, - "name": "__container__", + } + ] + }, + { + "id": 4846, + "name": "handler", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4847, + "name": "__type", "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - }, - "implementationOf": { - "type": "reference", - "target": 2721, - "name": "IBatchJobStrategy.__container__" - } - }, - { - "id": 2789, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - }, - "implementationOf": { - "type": "reference", - "target": 2723, - "name": "IBatchJobStrategy.__moduleDeclaration__" - } - }, - { - "id": 2760, - "name": "batchJobService_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isAbstract": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", - "qualifiedName": "BatchJobService" - }, - "name": "BatchJobService", - "package": "@medusajs/medusa" - } - }, - { - "id": 2783, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - }, - "implementationOf": { - "type": "reference", - "target": 2717, - "name": "IBatchJobStrategy.manager_" - } - }, - { - "id": 2784, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - }, - "implementationOf": { - "type": "reference", - "target": 2718, - "name": "IBatchJobStrategy.transactionManager_" - } - }, - { - "id": 2749, - "name": "_isBatchJobStrategy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 2751, - "name": "batchType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2750, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2785, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 2786, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "IBatchJobStrategy.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - }, - "implementationOf": { - "type": "reference", - "target": 2719, - "name": "IBatchJobStrategy.activeManager_" - } - }, - { - "id": 2798, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2799, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 2800, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 2801, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 2802, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2803, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2804, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2805, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 2806, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 2807, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2808, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2809, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 2810, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2811, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2812, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2813, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - }, - "implementationOf": { - "type": "reference", - "target": 2733, - "name": "IBatchJobStrategy.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - }, - "implementationOf": { - "type": "reference", - "target": 2732, - "name": "IBatchJobStrategy.atomicPhase_" - } - }, - { - "id": 2771, - "name": "buildTemplate", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 2772, - "name": "buildTemplate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Builds and returns a template file that can be downloaded and filled in" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2716, - "name": "IBatchJobStrategy.buildTemplate" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2715, - "name": "IBatchJobStrategy.buildTemplate" - } - }, - { - "id": 2777, - "name": "handleProcessingError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2778, - "name": "handleProcessingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 2779, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 2780, - "name": "batchJobId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2781, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 2782, - "name": "result", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2779, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2765, - "name": "preProcessBatchJob", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true - }, - "signatures": [ - { - "id": 2766, - "name": "preProcessBatchJob", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Method for pre-processing a batch job" - } - ] - }, - "parameters": [ - { - "id": 2767, - "name": "batchJobId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2710, - "name": "IBatchJobStrategy.preProcessBatchJob" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2709, - "name": "IBatchJobStrategy.preProcessBatchJob" - } - }, - { - "id": 2761, - "name": "prepareBatchJobForProcessing", - "variant": "declaration", - "kind": 2048, + "kind": 65536, "flags": {}, "signatures": [ { - "id": 2762, - "name": "prepareBatchJobForProcessing", + "id": 4848, + "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Method for preparing a batch job for processing" - } - ] - }, "parameters": [ { - "id": 2763, - "name": "batchJob", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3807, - "name": "CreateBatchJobInput", - "package": "@medusajs/medusa" - } - }, - { - "id": 2764, + "id": 4849, "name": "req", "variant": "param", "kind": 32768, @@ -1495,79 +773,29 @@ "type": { "type": "reference", "target": { - "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", - "qualifiedName": "__global.Express.Request" + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Request" }, "name": "Request", - "package": "@types/express-serve-static-core", - "qualifiedName": "__global.Express.Request" + "package": "@types/express", + "qualifiedName": "e.Request" } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" }, - "typeArguments": [ - { - "type": "reference", - "target": 3807, - "name": "CreateBatchJobInput", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2706, - "name": "IBatchJobStrategy.prepareBatchJobForProcessing" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2705, - "name": "IBatchJobStrategy.prepareBatchJobForProcessing" - } - }, - { - "id": 2768, - "name": "processJob", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 2769, - "name": "processJob", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Method does the actual processing of the job. Should report back on the progress of the operation." - } - ] - }, - "parameters": [ { - "id": 2770, - "name": "batchJobId", + "id": 4850, + "name": "res", "variant": "param", "kind": 32768, "flags": {}, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Response" + }, + "name": "Response", + "package": "@types/express", + "qualifiedName": "e.Response" } } ], @@ -1585,14174 +813,1738 @@ ], "name": "Promise", "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2713, - "name": "IBatchJobStrategy.processJob" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2712, - "name": "IBatchJobStrategy.processJob" - } - }, - { - "id": 2773, - "name": "shouldRetryOnProcessingError", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2774, - "name": "shouldRetryOnProcessingError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2775, - "name": "batchJob", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Batch Job indicates an asynchronus task stored in the Medusa backend. Its status determines whether it has been executed or not." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/batch-job.ts", - "qualifiedName": "BatchJob" - }, - "name": "BatchJob", - "package": "@medusajs/medusa" - } - }, - { - "id": 2776, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "boolean" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2793, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2794, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2795, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 2796, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2797, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2797 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - }, - "implementationOf": { - "type": "reference", - "target": 2728, - "name": "IBatchJobStrategy.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - }, - "implementationOf": { - "type": "reference", - "target": 2727, - "name": "IBatchJobStrategy.shouldRetryTransaction_" - } - }, - { - "id": 2790, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2791, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2792, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - }, - "implementationOf": { - "type": "reference", - "target": 2725, - "name": "IBatchJobStrategy.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - }, - "implementationOf": { - "type": "reference", - "target": 2724, - "name": "IBatchJobStrategy.withTransaction" - } - }, - { - "id": 2752, - "name": "isBatchJobStrategy", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "signatures": [ - { - "id": 2753, - "name": "isBatchJobStrategy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2754, - "name": "object", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "object", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2704, - "name": "IBatchJobStrategy", - "package": "@medusajs/medusa" - } } } ] } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2755 - ] - }, - { - "title": "Properties", - "children": [ - 2788, - 2787, - 2789, - 2760, - 2783, - 2784, - 2749, - 2751, - 2750 - ] - }, - { - "title": "Accessors", - "children": [ - 2785 - ] - }, - { - "title": "Methods", - "children": [ - 2798, - 2771, - 2777, - 2765, - 2761, - 2768, - 2773, - 2793, - 2790, - 2752 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": 2704, - "name": "IBatchJobStrategy", - "package": "@medusajs/medusa" - } - ] + } }, { - "id": 2824, - "name": "AbstractCartCompletionStrategy", + "id": 2634, + "name": "wrapHandler", "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ + "kind": 64, + "flags": {}, + "signatures": [ { - "id": 2829, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2830, - "name": "new AbstractCartCompletionStrategy", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 2831, - "name": "__container__", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 2832, - "name": "__configModule__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2833, - "name": "__moduleDeclaration__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": 2824, - "name": "AbstractCartCompletionStrategy", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3762, - "name": "TransactionBaseService.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3761, - "name": "TransactionBaseService.constructor" - } - }, - { - "id": 2844, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - } - }, - { - "id": 2843, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - } - }, - { - "id": 2845, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - } - }, - { - "id": 2839, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - } - }, - { - "id": 2840, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - } - }, - { - "id": 2825, - "name": "_isCartCompletionStrategy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 2841, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 2842, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - } - }, - { - "id": 2854, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2855, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 2856, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 2857, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 2858, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2859, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2860, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2861, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 2862, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 2863, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2864, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2865, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 2866, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2867, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2868, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2869, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - } - }, - { - "id": 2834, - "name": "complete", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 2835, - "name": "complete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes a cart id and completes the cart. This for example takes place when\ncreating an order or confirming a swap." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the response for the completion request" - } - ] - } - ] - }, - "parameters": [ - { - "id": 2836, - "name": "cartId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the id of the Cart to complete." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2837, - "name": "idempotencyKey", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Idempotency Key is used to continue a process in case of any failure that might occur." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/idempotency-key.ts", - "qualifiedName": "IdempotencyKey" - }, - "name": "IdempotencyKey", - "package": "@medusajs/medusa" - } - }, - { - "id": 2838, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the request context for the completion request" - } - ] - }, - "type": { - "type": "reference", - "target": 4845, - "name": "RequestContext", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2814, - "name": "CartCompletionResponse", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2820, - "name": "ICartCompletionStrategy.complete" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2819, - "name": "ICartCompletionStrategy.complete" - } - }, - { - "id": 2849, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2850, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2851, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 2852, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2853, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2853 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - }, - { - "id": 2846, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, + "id": 2635, + "name": "wrapHandler", + "variant": "signature", + "kind": 4096, "flags": {}, - "signatures": [ - { - "id": 2847, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2848, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - } - }, - { - "id": 2826, - "name": "isCartCompletionStrategy", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "signatures": [ - { - "id": 2827, - "name": "isCartCompletionStrategy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2828, - "name": "object", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "object", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2818, - "name": "ICartCompletionStrategy", - "package": "@medusajs/medusa" - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2829 - ] - }, - { - "title": "Properties", - "children": [ - 2844, - 2843, - 2845, - 2839, - 2840, - 2825 - ] - }, - { - "title": "Accessors", - "children": [ - 2841 - ] - }, - { - "title": "Methods", - "children": [ - 2854, - 2834, - 2849, - 2846, - 2826 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": 2818, - "name": "ICartCompletionStrategy", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 2920, - "name": "AbstractFileService", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 2925, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2926, - "name": "new AbstractFileService", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 2927, - "name": "__container__", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 2928, - "name": "__configModule__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2929, - "name": "__moduleDeclaration__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": 2920, - "name": "AbstractFileService", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3762, - "name": "TransactionBaseService.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3761, - "name": "TransactionBaseService.constructor" - } - }, - { - "id": 2953, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - }, - "implementationOf": { - "type": "reference", - "target": 2894, - "name": "IFileService.__configModule__" - } - }, - { - "id": 2952, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - }, - "implementationOf": { - "type": "reference", - "target": 2893, - "name": "IFileService.__container__" - } - }, - { - "id": 2954, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - }, - "implementationOf": { - "type": "reference", - "target": 2895, - "name": "IFileService.__moduleDeclaration__" - } - }, - { - "id": 2948, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - }, - "implementationOf": { - "type": "reference", - "target": 2889, - "name": "IFileService.manager_" - } - }, - { - "id": 2949, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - }, - "implementationOf": { - "type": "reference", - "target": 2890, - "name": "IFileService.transactionManager_" - } - }, - { - "id": 2921, - "name": "_isFileService", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 2950, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 2951, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "IFileService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - }, - "implementationOf": { - "type": "reference", - "target": 2891, - "name": "IFileService.activeManager_" - } - }, - { - "id": 2963, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2964, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 2965, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 2966, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 2967, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2968, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2969, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2970, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 2971, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 2972, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2973, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2974, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 2975, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2976, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2977, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2978, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - }, - "implementationOf": { - "type": "reference", - "target": 2905, - "name": "IFileService.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - }, - "implementationOf": { - "type": "reference", - "target": 2904, - "name": "IFileService.atomicPhase_" - } - }, - { - "id": 2936, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 2937, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "remove file from fileservice" - } - ] - }, - "parameters": [ - { - "id": 2938, - "name": "fileData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Remove file described by record" - } - ] - }, - "type": { - "type": "reference", - "target": 4848, - "name": "DeleteFileType", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2878, - "name": "IFileService.delete" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2877, - "name": "IFileService.delete" - } - }, - { - "id": 2942, - "name": "getDownloadStream", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 2943, - "name": "getDownloadStream", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "download file from fileservice as stream" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "readable stream of the file to download" - } - ] - } - ] - }, - "parameters": [ - { - "id": 2944, - "name": "fileData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "file metadata relevant for fileservice to download the file" - } - ] - }, - "type": { - "type": "reference", - "target": 4868, - "name": "GetUploadedFileType", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/@types/node/globals.d.ts", - "qualifiedName": "NodeJS.ReadableStream" - }, - "name": "ReadableStream", - "package": "@types/node", - "qualifiedName": "NodeJS.ReadableStream" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2884, - "name": "IFileService.getDownloadStream" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2883, - "name": "IFileService.getDownloadStream" - } - }, - { - "id": 2945, - "name": "getPresignedDownloadUrl", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 2946, - "name": "getPresignedDownloadUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate a presigned download url to obtain a file" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "presigned url to download the file" - } - ] - } - ] - }, - "parameters": [ - { - "id": 2947, - "name": "fileData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "file metadata relevant for fileservice to download the file" - } - ] - }, - "type": { - "type": "reference", - "target": 4868, - "name": "GetUploadedFileType", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2887, - "name": "IFileService.getPresignedDownloadUrl" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2886, - "name": "IFileService.getPresignedDownloadUrl" - } - }, - { - "id": 2939, - "name": "getUploadStreamDescriptor", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 2940, - "name": "getUploadStreamDescriptor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "upload file to fileservice from stream" - } - ] - }, - "parameters": [ - { - "id": 2941, - "name": "fileData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "file metadata relevant for fileservice to create and upload the file" - } - ] - }, - "type": { - "type": "reference", - "target": 4853, - "name": "UploadStreamDescriptorType", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4860, - "name": "FileServiceGetUploadStreamResult", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2881, - "name": "IFileService.getUploadStreamDescriptor" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2880, - "name": "IFileService.getUploadStreamDescriptor" - } - }, - { - "id": 2958, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2959, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2960, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 2961, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2962, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2962 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - }, - "implementationOf": { - "type": "reference", - "target": 2900, - "name": "IFileService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - }, - "implementationOf": { - "type": "reference", - "target": 2899, - "name": "IFileService.shouldRetryTransaction_" - } - }, - { - "id": 2930, - "name": "upload", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 2931, - "name": "upload", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "upload file to fileservice" - } - ] - }, - "parameters": [ - { - "id": 2932, - "name": "fileData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Multer file from express multipart/form-data" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/multer/index.d.ts", - "qualifiedName": "__global.Express.Multer.File" - }, - "name": "File", - "package": "@types/multer", - "qualifiedName": "__global.Express.Multer.File" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4759, - "name": "FileServiceUploadResult", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2872, - "name": "IFileService.upload" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2871, - "name": "IFileService.upload" - } - }, - { - "id": 2933, - "name": "uploadProtected", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 2934, - "name": "uploadProtected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "upload private file to fileservice" - } - ] - }, - "parameters": [ - { - "id": 2935, - "name": "fileData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Multer file from express multipart/form-data" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/multer/index.d.ts", - "qualifiedName": "__global.Express.Multer.File" - }, - "name": "File", - "package": "@types/multer", - "qualifiedName": "__global.Express.Multer.File" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4759, - "name": "FileServiceUploadResult", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2875, - "name": "IFileService.uploadProtected" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2874, - "name": "IFileService.uploadProtected" - } - }, - { - "id": 2955, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2956, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2957, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - }, - "implementationOf": { - "type": "reference", - "target": 2897, - "name": "IFileService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - }, - "implementationOf": { - "type": "reference", - "target": 2896, - "name": "IFileService.withTransaction" - } - }, - { - "id": 2922, - "name": "isFileService", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "signatures": [ - { - "id": 2923, - "name": "isFileService", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2924, - "name": "object", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "object", - "asserts": false, - "targetType": { - "type": "reference", - "target": 2920, - "name": "AbstractFileService", - "package": "@medusajs/medusa" - } - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2925 - ] - }, - { - "title": "Properties", - "children": [ - 2953, - 2952, - 2954, - 2948, - 2949, - 2921 - ] - }, - { - "title": "Accessors", - "children": [ - 2950 - ] - }, - { - "title": "Methods", - "children": [ - 2963, - 2936, - 2942, - 2945, - 2939, - 2958, - 2930, - 2933, - 2955, - 2922 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": 2870, - "name": "IFileService", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 3056, - "name": "AbstractFulfillmentService", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 3062, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3063, - "name": "new AbstractFulfillmentService", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "You can use the " - }, - { - "kind": "code", - "text": "`constructor`" - }, - { - "kind": "text", - "text": " of your fulfillment provider to access the different services in Medusa through dependency injection.\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the service.\nAdditionally, if you’re creating your fulfillment provider as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, you can access it in the constructor." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n constructor(container, options) {\n super(container)\n // you can access options here\n\n // you can also initialize a client that\n // communicates with a third-party service.\n this.client = new Client(options)\n }\n // ...\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3064, - "name": "container", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An instance of " - }, - { - "kind": "code", - "text": "`MedusaContainer`" - }, - { - "kind": "text", - "text": " that allows you to access other resources, such as services, in your Medusa backend." - } - ] - }, - "type": { - "type": "reference", - "target": 4878, - "name": "MedusaContainer", - "package": "@medusajs/types" - } - }, - { - "id": 3065, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If this fulfillment provider is created in a plugin, the plugin's options are passed in this parameter." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": 3056, - "name": "AbstractFulfillmentService", - "package": "@medusajs/medusa" - }, - "overwrites": { - "type": "reference", - "target": 3762, - "name": "TransactionBaseService.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 3761, - "name": "TransactionBaseService.constructor" - } - }, - { - "id": 3118, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - }, - "implementationOf": { - "type": "reference", - "target": 3030, - "name": "FulfillmentService.__configModule__" - } - }, - { - "id": 3117, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - }, - "implementationOf": { - "type": "reference", - "target": 3029, - "name": "FulfillmentService.__container__" - } - }, - { - "id": 3119, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - }, - "implementationOf": { - "type": "reference", - "target": 3031, - "name": "FulfillmentService.__moduleDeclaration__" - } - }, - { - "id": 3067, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, "comment": { - "summary": [ - { - "kind": "text", - "text": "If this fulfillment provider is created in a plugin, the plugin's options are passed in this parameter." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3066, - "name": "container", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An instance of " - }, - { - "kind": "code", - "text": "`MedusaContainer`" - }, - { - "kind": "text", - "text": " that allows you to access other resources, such as services, in your Medusa backend." - } - ] - }, - "type": { - "type": "reference", - "target": 4878, - "name": "MedusaContainer", - "package": "@medusajs/types" - } - }, - { - "id": 3113, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - }, - "implementationOf": { - "type": "reference", - "target": 3025, - "name": "FulfillmentService.manager_" - } - }, - { - "id": 3114, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - }, - "implementationOf": { - "type": "reference", - "target": 3026, - "name": "FulfillmentService.transactionManager_" - } - }, - { - "id": 3061, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true, - "isStatic": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`FulfillmentProvider`" - }, - { - "kind": "text", - "text": " entity has 2 properties: " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`is_installed`" - }, - { - "kind": "text", - "text": ". The " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " property in the class is used when the fulfillment provider is created in the database.\nThe value of this property is also used to reference the fulfillment provider throughout Medusa. For example, it is used to [add a fulfillment provider](https://docs.medusajs.com/api/admin#regions_postregionsregionfulfillmentproviders) to a region." - } - ], + "summary": [], "blockTags": [ { - "tag": "@example", + "tag": "@deprecated", "content": [ + { + "kind": "text", + "text": "use " + }, { "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n static identifier = \"my-fulfillment\"\n\n // ...\n}\n```" + "text": "`import { wrapHandler } from \"@medusajs/utils\"`" } ] } ] }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3115, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 3116, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "FulfillmentService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - }, - "implementationOf": { - "type": "reference", - "target": 3027, - "name": "FulfillmentService.activeManager_" - } - }, - { - "id": 3128, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ + "parameters": [ { - "id": 3129, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, + "id": 2636, + "name": "fn", + "variant": "param", + "kind": 32768, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 3130, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 3131, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 3132, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3133, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3134, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3135, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 3136, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 3137, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3138, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3139, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3140, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3141, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3142, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3143, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], "type": { "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - }, - "implementationOf": { - "type": "reference", - "target": 3041, - "name": "FulfillmentService.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - }, - "implementationOf": { - "type": "reference", - "target": 3040, - "name": "FulfillmentService.atomicPhase_" - } - }, - { - "id": 3083, - "name": "calculatePrice", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3084, - "name": "calculatePrice", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used in different places, including:\n\n1. When the shipping options for a cart are retrieved during checkout. If a shipping option has their " - }, - { - "kind": "code", - "text": "`price_type`" - }, - { - "kind": "text", - "text": " set to calculated, this method is used to set the amount of the returned shipping option.\n2. When a shipping method is created. If the shipping option associated with the method has their " - }, - { - "kind": "code", - "text": "`price_type`" - }, - { - "kind": "text", - "text": " set to " - }, - { - "kind": "code", - "text": "`calculated`" - }, - { - "kind": "text", - "text": ", this method is used to set the " - }, - { - "kind": "code", - "text": "`price`" - }, - { - "kind": "text", - "text": " attribute of the shipping method in the database.\n3. When the cart's totals are calculated." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Used to set the price of the shipping method or option, based on the context the method is used in." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "text", - "text": "An example of calculating the price based on some custom logic:\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async calculatePrice(\n optionData: Record,\n data: Record,\n cart: Cart\n ): Promise {\n return cart.items.length * 1000\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\nIf your fulfillment provider does not provide any dynamically calculated rates you can return any static value or throw an error. For example:\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async calculatePrice(\n optionData: Record,\n data: Record,\n cart: Cart\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3085, - "name": "optionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object of the selected shipping option." - } - ] - }, - "type": { - "type": "reference", - "target": 4874, - "name": "ShippingOptionData", - "package": "@medusajs/medusa" - } - }, - { - "id": 3086, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object that is different based on the context it's used in:\n\n1. If the price is being calculated for the list of shipping options available for a cart, it's the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object of the shipping option.\n2. If the price is being calculated when the shipping method is being created, it's the data returned by the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "validateFulfillmentData", - "target": 2984, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " method used during the shipping method creation.\n3. If the price is being calculated while calculating the cart's totals, it will be the data object of the cart's shipping method." - } - ] - }, - "type": { - "type": "reference", - "target": 4875, - "name": "FulfillmentProviderData", - "package": "@medusajs/medusa" - } - }, - { - "id": 3087, - "name": "cart", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "number" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2996, - "name": "FulfillmentService.calculatePrice" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2995, - "name": "FulfillmentService.calculatePrice" - } - }, - { - "id": 3080, - "name": "canCalculate", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3081, - "name": "canCalculate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to determine whether a shipping option is calculated dynamically or flat rate. It is called if the " - }, - { - "kind": "code", - "text": "`price_type`" - }, - { - "kind": "text", - "text": " of the shipping option being created is set to calculated." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "If this method returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", that means that the price can be calculated dynamically and the shipping option can have the " - }, - { - "kind": "code", - "text": "`price_type`" - }, - { - "kind": "text", - "text": " set to calculated.\nThe amount property of the shipping option will then be set to null. The amount will be created later when the shipping method is created on checkout using the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "calculatePrice", - "target": 2995, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " method.\nIf the method returns " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ", an error is thrown as it means the selected shipping option is invalid and it can only have the " - }, - { - "kind": "code", - "text": "`flat_rate`" - }, - { - "kind": "text", - "text": " price type." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async canCalculate(\n data: Record\n ): Promise {\n return data.id === \"my-fulfillment-dynamic\"\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3082, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object of the shipping option being created. You can use this data to determine whether the shipping option should be calculated or not.\nThis is useful if the fulfillment provider you are integrating has both flat rate and dynamically priced fulfillment options." - } - ] - }, - "type": { - "type": "reference", - "target": 4874, - "name": "ShippingOptionData", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "boolean" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2993, - "name": "FulfillmentService.canCalculate" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2992, - "name": "FulfillmentService.canCalculate" - } - }, - { - "id": 3094, - "name": "cancelFulfillment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3095, - "name": "cancelFulfillment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is called when a fulfillment is cancelled by the admin. This fulfillment can be for an order, a claim, or a swap." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The method isn't expected to return any specific data." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "text", - "text": "This is the basic implementation of the method for a fulfillment provider that doesn't interact with a third-party provider to cancel the fulfillment:\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async cancelFulfillment(\n fulfillment: Record\n ): Promise {\n return {}\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3096, - "name": "fulfillment", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " attribute of the fulfillment being canceled" - } - ] - }, - "type": { - "type": "reference", - "target": 4875, - "name": "FulfillmentProviderData", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3007, - "name": "FulfillmentService.cancelFulfillment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3006, - "name": "FulfillmentService.cancelFulfillment" - } - }, - { - "id": 3088, - "name": "createFulfillment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3089, - "name": "createFulfillment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used when a fulfillment is created for an order, a claim, or a swap." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The data that will be stored in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " attribute of the created fulfillment." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "text", - "text": "Here is a basic implementation of " - }, - { - "kind": "code", - "text": "`createFulfillment`" - }, - { - "kind": "text", - "text": " for a fulfillment provider that does not interact with any third-party provider to create the fulfillment:\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async createFulfillment(\n data: Record,\n items: LineItem,\n order: Order,\n fulfillment: Fulfillment\n ) {\n // No data is being sent anywhere\n // No data to be stored in the fulfillment's data object\n return {}\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3090, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object of the shipping method associated with the resource, such as the order.\nYou can use it to access the data specific to the shipping option. This is based on your implementation of previous methods." - } - ] - }, - "type": { - "type": "reference", - "target": 4876, - "name": "ShippingMethodData", - "package": "@medusajs/medusa" - } - }, - { - "id": 3091, - "name": "items", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The line items in the order to be fulfilled. The admin can choose all or some of the items to fulfill." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", - "qualifiedName": "LineItem" - }, - "name": "LineItem", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 3092, - "name": "order", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "Order" - }, - "name": "Order", - "package": "@medusajs/medusa" - } - }, - { - "id": 3093, - "name": "fulfillment", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/fulfillment.ts", - "qualifiedName": "Fulfillment" - }, - "name": "Fulfillment", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4875, - "name": "FulfillmentProviderData", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3001, - "name": "FulfillmentService.createFulfillment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3000, - "name": "FulfillmentService.createFulfillment" - } - }, - { - "id": 3097, - "name": "createReturn", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3098, - "name": "createReturn", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fulfillment providers can also be used to return products. A shipping option can be used for returns if the " - }, - { - "kind": "code", - "text": "`is_return`" - }, - { - "kind": "text", - "text": " property is true or if an admin creates a Return Shipping Option from the settings.\nThis method is used when the admin [creates a return request](https://docs.medusajs.com/api/admin#orders_postordersorderreturns) for an order,\n[creates a swap](https://docs.medusajs.com/api/admin#orders_postordersorderswaps) for an order, or when the\n[customer creates a return of their order](https://docs.medusajs.com/api/store#returns_postreturns). The fulfillment is created automatically for the order return." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Used to set the value of the " - }, - { - "kind": "code", - "text": "`shipping_data`" - }, - { - "kind": "text", - "text": " attribute of the return being created." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "text", - "text": "This is the basic implementation of the method for a fulfillment provider that does not contact with a third-party provider to fulfill the return:\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async createReturn(\n returnOrder: CreateReturnType\n ): Promise> {\n return {}\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3099, - "name": "returnOrder", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the return that the fulfillment is being created for." - } - ] - }, - "type": { - "type": "reference", - "target": 4877, - "name": "CreateReturnType", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3010, - "name": "FulfillmentService.createReturn" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3009, - "name": "FulfillmentService.createReturn" - } - }, - { - "id": 3100, - "name": "getFulfillmentDocuments", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3101, - "name": "getFulfillmentDocuments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to retrieve any documents associated with a fulfillment. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async getFulfillmentDocuments(\n data: Record\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getFulfillmentDocuments()\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3102, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " attribute of the fulfillment that you're retrieving the documents for." - } - ] - }, - "type": { - "type": "reference", - "target": 4875, - "name": "FulfillmentProviderData", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3013, - "name": "FulfillmentService.getFulfillmentDocuments" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3012, - "name": "FulfillmentService.getFulfillmentDocuments" - } - }, - { - "id": 3070, - "name": "getFulfillmentOptions", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3071, - "name": "getFulfillmentOptions", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used when retrieving the list of fulfillment options available in a region, particularly by the [List Fulfillment Options API Route](https://docs.medusajs.com/api/admin#regions_getregionsregionfulfillmentoptions).\nFor example, if you’re integrating UPS as a fulfillment provider, you might support two fulfillment options: UPS Express Shipping and UPS Access Point. Each of these options can have different data associated with them." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The list of fulfillment options. These options don't have any required format. Later on, these options can be used when creating a shipping option,\nsuch as when using the [Create Shipping Option API Route](https://docs.medusajs.com/api/admin#shipping-options_postshippingoptions). The chosen fulfillment option, which is one of the\nitems in the array returned by this method, will be set in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object of the shipping option." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async getFulfillmentOptions(): Promise {\n return [\n {\n id: \"my-fulfillment\",\n },\n {\n id: \"my-fulfillment-dynamic\",\n },\n ]\n }\n}\n```" - } - ] - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2983, - "name": "FulfillmentService.getFulfillmentOptions" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2982, - "name": "FulfillmentService.getFulfillmentOptions" - } - }, - { - "id": 3103, - "name": "getReturnDocuments", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3104, - "name": "getReturnDocuments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to retrieve any documents associated with a return. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async getReturnDocuments(\n data: Record\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getReturnDocuments()\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3105, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data attribute of the return that you're retrieving the documents for." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3016, - "name": "FulfillmentService.getReturnDocuments" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3015, - "name": "FulfillmentService.getReturnDocuments" - } - }, - { - "id": 3106, - "name": "getShipmentDocuments", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3107, - "name": "getShipmentDocuments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to retrieve any documents associated with a shipment. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async getShipmentDocuments(\n data: Record\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getShipmentDocuments()\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3108, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " attribute of the shipment that you're retrieving the documents for." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3019, - "name": "FulfillmentService.getShipmentDocuments" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3018, - "name": "FulfillmentService.getShipmentDocuments" - } - }, - { - "id": 3109, - "name": "retrieveDocuments", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3110, - "name": "retrieveDocuments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to retrieve any documents associated with an order and its fulfillments. This method isn't used by default in the backend, but you can use it for\ncustom use cases such as allowing admins to download these documents." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async retrieveDocuments(\n fulfillmentData: Record,\n documentType: \"invoice\" | \"label\"\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getDocuments()\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3111, - "name": "fulfillmentData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " attribute of the order's fulfillment." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3112, - "name": "documentType", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of document to retrieve." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "label" - }, - { - "type": "literal", - "value": "invoice" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3022, - "name": "FulfillmentService.retrieveDocuments" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3021, - "name": "FulfillmentService.retrieveDocuments" - } - }, - { - "id": 3123, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3124, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3125, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 3126, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3127, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3127 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - }, - "implementationOf": { - "type": "reference", - "target": 3036, - "name": "FulfillmentService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - }, - "implementationOf": { - "type": "reference", - "target": 3035, - "name": "FulfillmentService.shouldRetryTransaction_" - } - }, - { - "id": 3072, - "name": "validateFulfillmentData", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3073, - "name": "validateFulfillmentData", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is called when a shipping method is created. This typically happens when the customer chooses a shipping option during checkout, when a shipping method is created\nfor an order return, or in other similar cases. The shipping option and its data are validated before the shipping method is created.\n\nYou can use the provided parameters to validate the chosen shipping option. For example, you can check if the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object passed as a second parameter includes all data needed to\nfulfill the shipment later on.\n\nIf any of the data is invalid, you can throw an error. This error will stop Medusa from creating a shipping method and the error message will be returned as a result of the API Route." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The data that will be stored in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " property of the shipping method to be created.\nMake sure the value you return contains everything you need to fulfill the shipment later on. The returned value may also be used to calculate the price of the shipping method\nif it doesn't have a set price. It will be passed along to the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "calculatePrice", - "target": 2995, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " method." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async validateFulfillmentData(\n optionData: Record,\n data: Record,\n cart: Cart\n ): Promise> {\n if (data.id !== \"my-fulfillment\") {\n throw new Error(\"invalid data\")\n }\n\n return {\n ...data,\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3074, - "name": "optionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data object of the shipping option selected when creating the shipping method." - } - ] - }, - "type": { - "type": "reference", - "target": 4874, - "name": "ShippingOptionData", - "package": "@medusajs/medusa" - } - }, - { - "id": 3075, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object passed in the body of the request." - } - ] - }, - "type": { - "type": "reference", - "target": 4875, - "name": "FulfillmentProviderData", - "package": "@medusajs/medusa" - } - }, - { - "id": 3076, - "name": "cart", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2985, - "name": "FulfillmentService.validateFulfillmentData" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2984, - "name": "FulfillmentService.validateFulfillmentData" - } - }, - { - "id": 3077, - "name": "validateOption", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3078, - "name": "validateOption", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Once the admin creates the shipping option, the data of the shipping option will be validated first using this method. This method is called when the [Create Shipping Option API Route](https://docs.medusajs.com/api/admin#shipping-options_postshippingoptions) is used." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Whether the fulfillment option is valid. If the returned value is false, an error is thrown and the shipping option will not be saved." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "text", - "text": "For example, you can use this method to ensure that the " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object is correct:\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async validateOption(\n data: Record\n ): Promise {\n return data.id == \"my-fulfillment\"\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3079, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the data object that is sent in the body of the request, basically, the data object of the shipping option. You can use this data to validate the shipping option before it is saved." - } - ] - }, - "type": { - "type": "reference", - "target": 4874, - "name": "ShippingOptionData", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "boolean" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 2990, - "name": "FulfillmentService.validateOption" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 2989, - "name": "FulfillmentService.validateOption" - } - }, - { - "id": 3120, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3121, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3122, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - }, - "implementationOf": { - "type": "reference", - "target": 3033, - "name": "FulfillmentService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - }, - "implementationOf": { - "type": "reference", - "target": 3032, - "name": "FulfillmentService.withTransaction" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3062 - ] - }, - { - "title": "Properties", - "children": [ - 3118, - 3117, - 3119, - 3067, - 3066, - 3113, - 3114, - 3061 - ] - }, - { - "title": "Accessors", - "children": [ - 3115 - ] - }, - { - "title": "Methods", - "children": [ - 3128, - 3083, - 3080, - 3094, - 3088, - 3097, - 3100, - 3070, - 3103, - 3106, - 3109, - 3123, - 3072, - 3077, - 3120 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": 2979, - "name": "FulfillmentService", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 3186, - "name": "AbstractNotificationService", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 3192, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3193, - "name": "new AbstractNotificationService", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 3194, - "name": "__container__", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3195, - "name": "__configModule__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3196, - "name": "__moduleDeclaration__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": 3186, - "name": "AbstractNotificationService", + "target": 4846, + "name": "handler", "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3762, - "name": "TransactionBaseService.constructor" } } ], - "inheritedFrom": { - "type": "reference", - "target": 3761, - "name": "TransactionBaseService.constructor" - } - }, - { - "id": 3214, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, "type": { "type": "reference", "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.RequestHandler" }, "typeArguments": [ { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", + "qualifiedName": "ParamsDictionary" + }, + "name": "ParamsDictionary", + "package": "@types/express-serve-static-core" }, { "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - }, - "implementationOf": { - "type": "reference", - "target": 3160, - "name": "INotificationService.__configModule__" - } - }, - { - "id": 3213, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - }, - "implementationOf": { - "type": "reference", - "target": 3159, - "name": "INotificationService.__container__" - } - }, - { - "id": 3215, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" + "name": "any" }, { "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - }, - "implementationOf": { - "type": "reference", - "target": 3161, - "name": "INotificationService.__moduleDeclaration__" - } - }, - { - "id": 3209, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - }, - "implementationOf": { - "type": "reference", - "target": 3155, - "name": "INotificationService.manager_" - } - }, - { - "id": 3210, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" + "name": "any" }, { "type": "reference", "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" + "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", + "qualifiedName": "QueryString.ParsedQs" }, - "name": "EntityManager", - "package": "typeorm" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - }, - "implementationOf": { - "type": "reference", - "target": 3156, - "name": "INotificationService.transactionManager_" - } - }, - { - "id": 3187, - "name": "_isNotificationService", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 3188, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3211, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 3212, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" + "name": "ParsedQs", + "package": "@types/qs", + "qualifiedName": "QueryString.ParsedQs" }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "INotificationService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - }, - "implementationOf": { - "type": "reference", - "target": 3157, - "name": "INotificationService.activeManager_" - } - }, - { - "id": 3224, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3225, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 3226, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 3227, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 3228, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3229, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3230, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3231, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 3232, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 3233, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3234, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3235, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3236, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3237, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3238, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3239, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { + { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "qualifiedName": "Record" }, "typeArguments": [ { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - }, - "implementationOf": { - "type": "reference", - "target": 3171, - "name": "INotificationService.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - }, - "implementationOf": { - "type": "reference", - "target": 3170, - "name": "INotificationService.atomicPhase_" - } - }, - { - "id": 3197, - "name": "getIdentifier", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3198, - "name": "getIdentifier", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 3204, - "name": "resendNotification", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3205, - "name": "resendNotification", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3206, - "name": "notification", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 3207, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 3208, - "name": "attachmentGenerator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4889, - "name": "ReturnedData", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3151, - "name": "INotificationService.resendNotification" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3150, - "name": "INotificationService.resendNotification" - } - }, - { - "id": 3199, - "name": "sendNotification", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3200, - "name": "sendNotification", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3201, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { "type": "intrinsic", "name": "string" - } - }, - { - "id": 3202, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 3203, - "name": "attachmentGenerator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4889, - "name": "ReturnedData", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3146, - "name": "INotificationService.sendNotification" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3145, - "name": "INotificationService.sendNotification" - } - }, - { - "id": 3219, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3220, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3221, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 3222, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3223, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3223 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - }, - "implementationOf": { - "type": "reference", - "target": 3166, - "name": "INotificationService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - }, - "implementationOf": { - "type": "reference", - "target": 3165, - "name": "INotificationService.shouldRetryTransaction_" - } - }, - { - "id": 3216, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3217, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3218, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - }, - "implementationOf": { - "type": "reference", - "target": 3163, - "name": "INotificationService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - }, - "implementationOf": { - "type": "reference", - "target": 3162, - "name": "INotificationService.withTransaction" - } - }, - { - "id": 3189, - "name": "isNotificationService", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "signatures": [ - { - "id": 3190, - "name": "isNotificationService", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3191, - "name": "object", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { + { "type": "intrinsic", "name": "any" } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" + ], + "name": "Record", + "package": "typescript" } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3192 - ] - }, - { - "title": "Properties", - "children": [ - 3214, - 3213, - 3215, - 3209, - 3210, - 3187, - 3188 - ] - }, - { - "title": "Accessors", - "children": [ - 3211 - ] - }, - { - "title": "Methods", - "children": [ - 3224, - 3197, - 3204, - 3199, - 3219, - 3216, - 3189 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": 3144, - "name": "INotificationService", - "package": "@medusajs/medusa" + ], + "name": "RequestHandler", + "package": "@types/express", + "qualifiedName": "e.RequestHandler" + } } ] }, { - "id": 3300, - "name": "AbstractPaymentProcessor", + "id": 2637, + "name": "canAccessBatchJob", "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "## Overview\n\nA Payment Processor is the payment method used to authorize, capture, and refund payment, among other actions. An example of a Payment Processor is Stripe.\n\nBy default, Medusa has a " - }, - { - "kind": "code", - "text": "`manual`" - }, - { - "kind": "text", - "text": " payment provider that has minimal implementation. It can be synonymous with a Cash on Delivery payment method. It allows\nstore operators to manage the payment themselves but still keep track of its different stages on Medusa.\n\nA payment processor is a service that extends the " - }, - { - "kind": "code", - "text": "`AbstractPaymentProcessor`" - }, - { - "kind": "text", - "text": " and implements its methods. So, adding a Payment Processor is as simple as\ncreating a service file in " - }, - { - "kind": "code", - "text": "`src/services`" - }, - { - "kind": "text", - "text": ". The file's name is the payment processor's class name as a slug and without the word " - }, - { - "kind": "code", - "text": "`Service`" - }, - { - "kind": "text", - "text": ".\nFor example, if you're creating a " - }, - { - "kind": "code", - "text": "`MyPaymentService`" - }, - { - "kind": "text", - "text": " class, the file name is " - }, - { - "kind": "code", - "text": "`src/services/my-payment.ts`" - }, - { - "kind": "text", - "text": ".\n\n" - }, - { - "kind": "code", - "text": "```ts\nimport { AbstractPaymentProcessor } from \"@medusajs/medusa\";\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // methods here...\n}\n\nexport default MyPaymentService\n```" - }, - { - "kind": "text", - "text": "\n\nThe methods of the payment processor are used at different points in the Checkout flow as well as when processing an order after it’s placed.\n\n![Checkout Flow - Payment](https://res.cloudinary.com/dza7lstvk/image/upload/v1680177820/Medusa%20Docs/Diagrams/checkout-payment_cy9efp.jpg)\n\n---\n\n## Identifier Property\n\nThe " - }, - { - "kind": "code", - "text": "`PaymentProvider`" - }, - { - "kind": "text", - "text": " entity has 2 properties: " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`is_installed`" - }, - { - "kind": "text", - "text": ". The " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " property in the payment processor service is used when the payment processor is added to the database.\n\nThe value of this property is also used to reference the payment processor throughout Medusa.\nFor example, it is used to [add a payment processor](https://docs.medusajs.com/api/admin#regions_postregionsregionpaymentproviders) to a region.\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyPaymentService extends AbstractPaymentProcessor {\n static identifier = \"my-payment\"\n // ...\n}\n```" - }, - { - "kind": "text", - "text": "\n\n---\n\n## PaymentProcessorError\n\nBefore diving into the methods of the Payment Processor, you'll notice that part of the expected return signature of these method includes " - }, - { - "kind": "code", - "text": "`PaymentProcessorError`" - }, - { - "kind": "text", - "text": ".\n\n" - }, - { - "kind": "code", - "text": "```ts\ninterface PaymentProcessorError {\n error: string\n code?: string\n detail?: any\n}\n```" - }, - { - "kind": "text", - "text": "\n\nWhile implementing the Payment Processor's methods, if you need to inform the Medusa core that an error occurred at a certain stage,\nreturn an object having the attributes defined in the " - }, - { - "kind": "code", - "text": "`PaymentProcessorError`" - }, - { - "kind": "text", - "text": " interface.\n\nFor example, the Stripe payment processor has the following method to create the error object, which is used within other methods:\n\n" - }, - { - "kind": "code", - "text": "```ts\nabstract class StripeBase extends AbstractPaymentProcessor {\n // ...\n protected buildError(\n message: string,\n e: Stripe.StripeRawError | PaymentProcessorError | Error\n ): PaymentProcessorError {\n return {\n error: message,\n code: \"code\" in e ? e.code : \"\",\n detail: isPaymentProcessorError(e)\n ? `${e.error}${EOL}${e.detail ?? \"\"}`\n : \"detail\" in e\n ? e.detail\n : e.message ?? \"\",\n }\n }\n\n // used in other methods\n async retrievePayment(\n paymentSessionData: Record\n ): Promise<\n PaymentProcessorError |\n PaymentProcessorSessionResponse[\"session_data\"]\n > {\n try {\n // ...\n } catch (e) {\n return this.buildError(\n \"An error occurred in retrievePayment\",\n e\n )\n }\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n---" - } - ] - }, - "children": [ + "kind": 64, + "flags": {}, + "signatures": [ { - "id": 3306, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": { - "isProtected": true - }, - "signatures": [ + "id": 2638, + "name": "canAccessBatchJob", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ { - "id": 3307, - "name": "new AbstractPaymentProcessor", - "variant": "signature", - "kind": 16384, + "id": 2639, + "name": "req", + "variant": "param", + "kind": 32768, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "You can use the " - }, - { - "kind": "code", - "text": "`constructor`" - }, - { - "kind": "text", - "text": " of your Payment Processor to have access to different services in Medusa through [dependency injection](https://docs.medusajs.com/development/fundamentals/dependency-injection).\n\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs,\nyou can initialize it in the constructor and use it in other methods in the service.\n\nAdditionally, if you’re creating your Payment Processor as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin,\nyou can access it in the constructor. The options are passed as a second parameter." - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n constructor(container, options) {\n super(container)\n // you can access options here\n\n // you can also initialize a client that\n // communicates with a third-party service.\n this.client = new Client(options)\n }\n // ...\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3308, - "name": "container", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An instance of " - }, - { - "kind": "code", - "text": "`MedusaContainer`" - }, - { - "kind": "text", - "text": " that allows you to access other resources, such as services, in your Medusa backend through [dependency injection](https://docs.medusajs.com/development/fundamentals/dependency-injection)" - } - ] - }, - "type": { - "type": "reference", - "target": 4894, - "name": "MedusaContainer", - "package": "medusa-core-utils" - } - }, - { - "id": 3309, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If this fulfillment provider is created in a plugin, the plugin's options are passed in this parameter." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], "type": { - "type": "reference", - "target": 3300, - "name": "AbstractPaymentProcessor", - "package": "@medusajs/medusa" + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 2640, + "name": "res", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 2641, + "name": "next", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" } } - ] - }, - { - "id": 3311, - "name": "config", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If this fulfillment provider is created in a plugin, the plugin's options are passed in this parameter." - } - ] - }, + ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" + "qualifiedName": "Promise" }, "typeArguments": [ { "type": "intrinsic", - "name": "string" + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2642, + "name": "getRequestedBatchJob", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2643, + "name": "getRequestedBatchJob", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2644, + "name": "req", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 2645, + "name": "res", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 2646, + "name": "next", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2647, + "name": "doesConditionBelongToDiscount", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2648, + "name": "doesConditionBelongToDiscount", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2649, + "name": "req", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 2650, + "name": "res", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 2651, + "name": "next", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2626, + "name": "errorHandler", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2627, + "name": "errorHandler", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2628, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2629, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2630, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4819, + "name": "MedusaError", + "package": "medusa-core-utils" + } + }, + { + "id": 2631, + "name": "req", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Request" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", + "qualifiedName": "ParamsDictionary" + }, + "name": "ParamsDictionary", + "package": "@types/express-serve-static-core" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", + "qualifiedName": "QueryString.ParsedQs" + }, + "name": "ParsedQs", + "package": "@types/qs", + "qualifiedName": "QueryString.ParsedQs" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "Request", + "package": "@types/express", + "qualifiedName": "e.Request" + } + }, + { + "id": 2632, + "name": "res", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Response" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "Response", + "package": "@types/express", + "qualifiedName": "e.Response" + } + }, + { + "id": 2633, + "name": "next", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.NextFunction" + }, + "name": "NextFunction", + "package": "@types/express", + "qualifiedName": "e.NextFunction" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ] + }, + { + "id": 2652, + "name": "normalizeQuery", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2653, + "name": "normalizeQuery", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Normalize an input query, especially from array like query params to an array type\ne.g: /admin/orders/?fields[]=id,status,cart_id becomes { fields: [\"id\", \"status\", \"cart_id\"] }" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2654, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2655, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2656, + "name": "req", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Request" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", + "qualifiedName": "ParamsDictionary" + }, + "name": "ParamsDictionary", + "package": "@types/express-serve-static-core" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", + "qualifiedName": "QueryString.ParsedQs" + }, + "name": "ParsedQs", + "package": "@types/qs", + "qualifiedName": "QueryString.ParsedQs" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "Request", + "package": "@types/express", + "qualifiedName": "e.Request" + } + }, + { + "id": 2657, + "name": "res", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Response" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "Response", + "package": "@types/express", + "qualifiedName": "e.Response" + } + }, + { + "id": 2658, + "name": "next", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.NextFunction" + }, + "name": "NextFunction", + "package": "@types/express", + "qualifiedName": "e.NextFunction" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ] + }, + { + "id": 2659, + "name": "requireCustomerAuthentication", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2660, + "name": "requireCustomerAuthentication", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.RequestHandler" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", + "qualifiedName": "ParamsDictionary" + }, + "name": "ParamsDictionary", + "package": "@types/express-serve-static-core" }, { "type": "intrinsic", - "name": "unknown" + "name": "any" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", + "qualifiedName": "QueryString.ParsedQs" + }, + "name": "ParsedQs", + "package": "@types/qs", + "qualifiedName": "QueryString.ParsedQs" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" } ], - "name": "Record", - "package": "typescript" + "name": "RequestHandler", + "package": "@types/express", + "qualifiedName": "e.RequestHandler" } - }, + } + ] + }, + { + "id": 2661, + "name": "transformBody", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ { - "id": 3310, - "name": "container", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An instance of " - }, - { - "kind": "code", - "text": "`MedusaContainer`" - }, - { - "kind": "text", - "text": " that allows you to access other resources, such as services, in your Medusa backend through [dependency injection](https://docs.medusajs.com/development/fundamentals/dependency-injection)" + "id": 2662, + "name": "transformBody", + "variant": "signature", + "kind": 4096, + "flags": {}, + "typeParameter": [ + { + "id": 2663, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 2664, + "name": "plainToClass", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3984, + "typeArguments": [ + { + "type": "reference", + "target": 2663, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "ClassConstructor", + "package": "@medusajs/medusa" } - ] - }, + }, + { + "id": 2665, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/class-validator/types/validation/ValidatorOptions.d.ts", + "qualifiedName": "ValidatorOptions" + }, + "name": "ValidatorOptions", + "package": "class-validator" + }, + "defaultValue": "..." + } + ], "type": { - "type": "reference", - "target": 4894, - "name": "MedusaContainer", - "package": "medusa-core-utils" - } - }, - { - "id": 3301, - "name": "_isPaymentProcessor", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 3305, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true, - "isStatic": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`PaymentProvider`" - }, - { - "kind": "text", - "text": " entity has 2 properties: " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`is_installed`" - }, - { - "kind": "text", - "text": ". The " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " property in the payment processor service is used when the payment processor is added to the database.\n\nThe value of this property is also used to reference the payment processor throughout Medusa.\nFor example, it is used to [add a payment processor](https://docs.medusajs.com/api/admin#regions_postregionsregionpaymentproviders) to a region.\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyPaymentService extends AbstractPaymentProcessor {\n static identifier = \"my-payment\"\n // ...\n}\n```" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3317, - "name": "authorizePayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3318, - "name": "authorizePayment", - "variant": "signature", - "kind": 4096, + "type": "reflection", + "declaration": { + "id": 2666, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to authorize payment using the Payment Session of an order. This is called when the\n[cart is completed](https://docs.medusajs.com/api/store#carts_postcartscartcomplete) and before the order is created.\n\nThis method is also used for authorizing payments of a swap of an order and when authorizing sessions in a payment collection.\nYou can interact with a third-party provider and perform any actions necessary to authorize the payment.\n\nThe payment authorization might require additional action from the customer before it is declared authorized. Once that additional action is performed,\nthe " - }, - { - "kind": "code", - "text": "`authorizePayment`" - }, - { - "kind": "text", - "text": " method will be called again to validate that the payment is now fully authorized. So, make sure to implement it for this case as well, if necessary.\n\nOnce the payment is authorized successfully and the Payment Session status is set to " - }, - { - "kind": "code", - "text": "`authorized`" - }, - { - "kind": "text", - "text": ", the associated order or swap can then be placed or created.\nIf the payment authorization fails, then an error will be thrown and the order will not be created.\n\n:::note\n\nThe payment authorization status is determined using the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "getPaymentStatus", - "target": 3293, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " method. If the status is " - }, - { - "kind": "code", - "text": "`requires_more`" - }, - { - "kind": "text", - "text": ", then it means additional actions are required\nfrom the customer. If you try to create the order with a status that isn't " - }, - { - "kind": "code", - "text": "`authorized`" - }, - { - "kind": "text", - "text": ", the process will fail.\n\n:::" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The authorization details or an error object." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError,\n PaymentSessionStatus,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async authorizePayment(\n paymentSessionData: Record,\n context: Record\n ): Promise<\n PaymentProcessorError |\n {\n status: PaymentSessionStatus;\n data: Record;\n }\n > {\n try {\n await this.client.authorize(paymentSessionData.id)\n\n return {\n status: PaymentSessionStatus.AUTHORIZED,\n data: {\n id: paymentSessionData.id\n }\n }\n } catch (e) {\n return {\n error: e.message\n }\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ + "signatures": [ { - "id": 3319, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, + "id": 2667, + "name": "__type", + "variant": "signature", + "kind": 4096, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the payment session." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3320, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The context of the authorization. It may include some of the following fields:\n\n- " - }, - { - "kind": "code", - "text": "`ip`" - }, - { - "kind": "text", - "text": ": The customer’s IP.\n- " - }, - { - "kind": "code", - "text": "`idempotency_key`" - }, - { - "kind": "text", - "text": ": The [Idempotency Key](https://docs.medusajs.com/modules/carts-and-checkout/payment#idempotency-key) that is associated with the current cart. It is useful when retrying payments, retrying checkout at a failed point, or for payments that require additional actions from the customer.\n- " - }, - { - "kind": "code", - "text": "`cart_id`" - }, - { - "kind": "text", - "text": ": The ID of a cart. This is only during operations like placing an order or creating a swap." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 3321, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3323, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3322, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSessionStatus" - }, - "name": "PaymentSessionStatus", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3323, - 3322 - ] - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3275, - "name": "PaymentProcessor.authorizePayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3274, - "name": "PaymentProcessor.authorizePayment" - } - }, - { - "id": 3324, - "name": "cancelPayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3325, - "name": "cancelPayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to cancel an order’s payment. This method is typically triggered by one of the following situations:\n\n1. Before an order is placed and after the payment is authorized, an inventory check is done on products to ensure that products are still available for purchase. If the inventory check fails for any of the products, the payment is canceled.\n2. If the store operator cancels the order from the admin.\n3. When the payment of an order's swap is canceled.\n\nYou can utilize this method to interact with the third-party provider and perform any actions necessary to cancel the payment." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Either an error object or a value that's stored in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async cancelPayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n const cancelData = this.client.cancel(paymentId)\n\n return {\n id: paymentId,\n ...cancelData\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3326, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { + "parameters": [ + { + "id": 2668, + "name": "req", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { "type": "reference", "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Request" }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" + "name": "Request", + "package": "@types/express", + "qualifiedName": "e.Request" } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3291, - "name": "PaymentProcessor.cancelPayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3290, - "name": "PaymentProcessor.cancelPayment" - } - }, - { - "id": 3314, - "name": "capturePayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3315, - "name": "capturePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to capture the payment amount of an order. This is typically triggered manually by the store operator from the admin.\n\nThis method is also used for capturing payments of a swap of an order, or when a request is sent to the [Capture Payment API Route](https://docs.medusajs.com/api/admin#payments_postpaymentspaymentcapture).\n\nYou can utilize this method to interact with the third-party provider and perform any actions necessary to capture the payment." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Either an error object or a value that's stored in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async capturePayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n const captureData = this.client.catch(paymentId)\n\n return {\n id: paymentId,\n ...captureData\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3316, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment for its first parameter." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { + { + "id": 2669, + "name": "res", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { "type": "reference", "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Response" }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" + "name": "Response", + "package": "@types/express", + "qualifiedName": "e.Response" } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3282, - "name": "PaymentProcessor.capturePayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3281, - "name": "PaymentProcessor.capturePayment" - } - }, - { - "id": 3330, - "name": "deletePayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3331, - "name": "deletePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to perform any actions necessary before a Payment Session is deleted. The Payment Session is deleted in one of the following cases:\n\n1. When a request is sent to [delete the Payment Session](https://docs.medusajs.com/api/store#carts_deletecartscartpaymentsessionssession).\n2. When the [Payment Session is refreshed](https://docs.medusajs.com/api/store#carts_postcartscartpaymentsessionssession). The Payment Session is deleted so that a newer one is initialized instead.\n3. When the Payment Processor is no longer available. This generally happens when the store operator removes it from the available Payment Processor in the admin.\n4. When the region of the store is changed based on the cart information and the Payment Processor is not available in the new region." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Either an error object or an empty object." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async deletePayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n // assuming client is an initialized client\n // communicating with a third-party service.\n this.client.delete(paymentId)\n\n return {}\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3332, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment Session." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { + { + "id": 2670, + "name": "next", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { "type": "reference", "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.NextFunction" }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" + "name": "NextFunction", + "package": "@types/express", + "qualifiedName": "e.NextFunction" } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3285, - "name": "PaymentProcessor.deletePayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3284, - "name": "PaymentProcessor.deletePayment" - } - }, - { - "id": 3333, - "name": "getPaymentStatus", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3334, - "name": "getPaymentStatus", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to get the status of a Payment or a Payment Session. Its main usage is within the place order and create swap flows.\nIf the status returned is not " - }, - { - "kind": "code", - "text": "`authorized`" - }, - { - "kind": "text", - "text": " within these flows, then the payment is considered failed and an error will be thrown, stopping the flow from completion." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The status of the Payment or Payment Session." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentSessionStatus\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async getPaymentStatus(\n paymentSessionData: Record\n ): Promise {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n return await this.client.getStatus(paymentId) as PaymentSessionStatus\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3335, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of a Payment as a parameter. You can use this data to interact with the third-party provider to check the status of the payment if necessary." - } - ] - }, + } + ], "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" + "qualifiedName": "Promise" }, "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSessionStatus" - }, - "name": "PaymentSessionStatus", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3294, - "name": "PaymentProcessor.getPaymentStatus" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3293, - "name": "PaymentProcessor.getPaymentStatus" - } - }, - { - "id": 3327, - "name": "initiatePayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3328, - "name": "initiatePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is called either if a region has only one payment provider enabled or when [a Payment Session is selected](https://docs.medusajs.com/api/store#carts_postcartscartpaymentsession),\nwhich occurs when the customer selects their preferred payment method during checkout.\n\nIt is used to allow you to make any necessary calls to the third-party provider to initialize the payment. For example, in Stripe this method is used to create a Payment Intent for the customer." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Either the payment's data or an error object." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentContext,\n PaymentSessionResponse,\n // ...\n} from \"@medusajs/medusa\"\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async initiatePayment(\n context: PaymentProcessorContext\n ): Promise<\n PaymentProcessorError | PaymentProcessorSessionResponse\n > {\n // assuming client is an initialized client\n // communicating with a third-party service.\n const clientPayment = await this.client.initiate(context)\n\n return {\n session_data: {\n id: clientPayment.id\n },\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3329, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The context of the payment." - } - ] - }, - "type": { - "type": "reference", - "target": 3243, - "name": "PaymentProcessorContext", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3252, - "name": "PaymentProcessorSessionResponse", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3265, - "name": "PaymentProcessor.initiatePayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3264, - "name": "PaymentProcessor.initiatePayment" - } - }, - { - "id": 3336, - "name": "refundPayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3337, - "name": "refundPayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to refund an order’s payment. This is typically triggered manually by the store operator from the admin. The refund amount might be the total order amount or part of it.\n\nThis method is also used for refunding payments of a swap or a claim of an order, or when a request is sent to the [Refund Payment API Route](https://docs.medusajs.com/api/admin#payments_postpaymentspaymentrefunds).\n\nYou can utilize this method to interact with the third-party provider and perform any actions necessary to refund the payment." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Either an error object or a value that's stored in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async refundPayment(\n paymentSessionData: Record,\n refundAmount: number\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n const refundData = this.client.refund(paymentId, refundAmount)\n\n return {\n id: paymentId,\n ...refundData\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3338, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of a Payment." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3339, - "name": "refundAmount", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the amount to refund." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3271, - "name": "PaymentProcessor.refundPayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3270, - "name": "PaymentProcessor.refundPayment" - } - }, - { - "id": 3340, - "name": "retrievePayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3341, - "name": "retrievePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to provide a uniform way of retrieving the payment information from the third-party provider.\nFor example, in Stripe’s Payment Processor this method is used to retrieve the payment intent details from Stripe." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The payment's data, typically retrieved from a third-party provider." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async retrievePayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n return await this.client.retrieve(paymentId)\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3342, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of a Payment Session. Make sure to store in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field any necessary data that would allow you to retrieve the payment data from the third-party provider." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3288, - "name": "PaymentProcessor.retrievePayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3287, - "name": "PaymentProcessor.retrievePayment" - } - }, - { - "id": 3343, - "name": "updatePayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3344, - "name": "updatePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to update the payment session when the payment amount changes. It's called whenever the cart or any of its related data is updated.\nFor example, when a [line item is added to the cart](https://docs.medusajs.com/api/store#carts_postcartscartlineitems) or when a\n[shipping method is selected](https://docs.medusajs.com/api/store#carts_postcartscartshippingmethod)." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Either the payment's data or an error object." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorContext,\n PaymentProcessorError,\n PaymentProcessorSessionResponse,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async updatePayment(\n context: PaymentProcessorContext\n ): Promise<\n void |\n PaymentProcessorError |\n PaymentProcessorSessionResponse\n > {\n // assuming client is an initialized client\n // communicating with a third-party service.\n const paymentId = context.paymentSessionData.id\n\n await this.client.update(paymentId, context)\n\n return {\n session_data: context.paymentSessionData\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3345, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The context of the payment." - } - ] - }, - "type": { - "type": "reference", - "target": 3243, - "name": "PaymentProcessorContext", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ { "type": "intrinsic", "name": "void" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3252, - "name": "PaymentProcessorSessionResponse", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3268, - "name": "PaymentProcessor.updatePayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3267, - "name": "PaymentProcessor.updatePayment" - } - }, - { - "id": 3346, - "name": "updatePaymentData", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3347, - "name": "updatePaymentData", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to update the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of a payment session. It's called when a request is sent to the\n[Update Payment Session API Route](https://docs.medusajs.com/api/store#carts_postcartscartpaymentsessionupdate), or when the " - }, - { - "kind": "code", - "text": "`CartService`" - }, - { - "kind": "text", - "text": "'s " - }, - { - "kind": "code", - "text": "`updatePaymentSession`" - }, - { - "kind": "text", - "text": " is used.\n\nThis method can also be used to update the data in the third-party payment provider, if necessary." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the data to store in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the payment session.\nYou can keep the data as-is, or make changes to it by communicating with the third-party provider." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError,\n PaymentProviderService,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n protected paymentProviderService: PaymentProviderService\n // ...\n constructor(container, options) {\n super(container)\n this.paymentProviderService = container.paymentProviderService\n // ...\n }\n // ...\n async updatePaymentData(\n sessionId: string,\n data: Record\n ): Promise<\n Record |\n PaymentProcessorError\n > {\n const paymentSession = await this.paymentProviderService.retrieveSession(sessionId)\n // assuming client is an initialized client\n // communicating with a third-party service.\n const clientPayment = await this.client.update(paymentSession.data.id, data)\n\n return {\n id: clientPayment.id\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3348, - "name": "sessionId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the payment session." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3349, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data to be updated in the payment session." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" } ], - "name": "Record", + "name": "Promise", "package": "typescript" } } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3297, - "name": "PaymentProcessor.updatePaymentData" - } + ] } - ], - "implementationOf": { - "type": "reference", - "target": 3296, - "name": "PaymentProcessor.updatePaymentData" } - }, - { - "id": 3302, - "name": "isPaymentProcessor", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "signatures": [ - { - "id": 3303, - "name": "isPaymentProcessor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3304, - "name": "object", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3306 - ] - }, - { - "title": "Properties", - "children": [ - 3311, - 3310, - 3301, - 3305 - ] - }, - { - "title": "Methods", - "children": [ - 3317, - 3324, - 3314, - 3330, - 3333, - 3327, - 3336, - 3340, - 3343, - 3346, - 3302 - ] - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": 3261, - "name": "PaymentProcessor", - "package": "@medusajs/medusa" } ] }, { - "id": 3456, - "name": "AbstractPaymentService", + "id": 2671, + "name": "transformIncludesOptions", "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2672, + "name": "transformIncludesOptions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ { "kind": "text", - "text": "in the near future use the AbstractPaymentProcessor instead" - } - ] - } - ] - }, - "children": [ - { - "id": 3462, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3463, - "name": "new AbstractPaymentService", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 3464, - "name": "container", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 3465, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": 3456, - "name": "AbstractPaymentService", - "package": "@medusajs/medusa" - }, - "overwrites": { - "type": "reference", - "target": 3762, - "name": "TransactionBaseService.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": 3761, - "name": "TransactionBaseService.constructor" - } - }, - { - "id": 3521, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.__configModule__" - } - }, - { - "id": 3520, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.__container__" - } - }, - { - "id": 3522, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.__moduleDeclaration__" - } - }, - { - "id": 3516, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.manager_" - } - }, - { - "id": 3517, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" + "text": "Retrieve the includes options from the fields query param.\nIf the include option is present then assigned it to includes on req" } ] }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.transactionManager_" - } - }, - { - "id": 3457, - "name": "_isPaymentService", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 3461, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true, - "isStatic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3518, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 3519, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.activeManager_" - } - }, - { - "id": 3531, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ + "parameters": [ { - "id": 3532, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, + "id": 2673, + "name": "allowedIncludes", + "variant": "param", + "kind": 32768, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] + "text": "The list of fields that can be passed and assign to req.includes" } ] }, - "typeParameter": [ - { - "id": 3533, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 3534, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" } - ], - "parameters": [ - { - "id": 3535, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] + }, + "defaultValue": "[]" + }, + { + "id": 2674, + "name": "expectedIncludes", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of fields that the consumer can pass to the end point using this middleware. It is a subset of " }, - "type": { - "type": "reflection", - "declaration": { - "id": 3536, - "name": "__type", - "variant": "declaration", - "kind": 65536, + { + "kind": "code", + "text": "`allowedIncludes`" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "[]" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 2675, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2676, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2677, + "name": "req", + "variant": "param", + "kind": 32768, "flags": {}, - "signatures": [ - { - "id": 3537, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3538, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Request" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", + "qualifiedName": "ParamsDictionary" + }, + "name": "ParamsDictionary", + "package": "@types/express-serve-static-core" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "intrinsic", + "name": "any" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", + "qualifiedName": "QueryString.ParsedQs" + }, + "name": "ParsedQs", + "package": "@types/qs", + "qualifiedName": "QueryString.ParsedQs" + }, + { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "qualifiedName": "Record" }, "typeArguments": [ { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" } ], - "name": "Promise", + "name": "Record", "package": "typescript" } - } - ] - } - } - }, - { - "id": 3539, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." + ], + "name": "Request", + "package": "@types/express", + "qualifiedName": "e.Request" } - ] - }, - "type": { - "type": "union", - "types": [ - { + }, + { + "id": 2678, + "name": "res", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { "type": "reference", "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Response" }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 3540, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3541, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3542, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3543, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3544, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3545, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3546, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + }, + { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "qualifiedName": "Record" }, "typeArguments": [ { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" } ], - "name": "Promise", + "name": "Record", "package": "typescript" } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.atomicPhase_" - } - }, - { - "id": 3490, - "name": "authorizePayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3491, - "name": "authorizePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "parameters": [ - { - "id": 3492, - "name": "paymentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections." + ], + "name": "Response", + "package": "@types/express", + "qualifiedName": "e.Response" } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSession" }, - "name": "PaymentSession", - "package": "@medusajs/medusa" - } - }, - { - "id": 3493, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 3494, - "name": "__type", - "variant": "declaration", - "kind": 65536, + { + "id": 2679, + "name": "next", + "variant": "param", + "kind": 32768, "flags": {}, - "children": [ - { - "id": 3495, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - }, - { - "id": 3496, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSessionStatus" - }, - "name": "PaymentSessionStatus", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3495, - 3496 - ] - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.authorizePayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.authorizePayment" - } - }, - { - "id": 3504, - "name": "cancelPayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3505, - "name": "cancelPayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3506, - "name": "payment", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment.ts", - "qualifiedName": "Payment" - }, - "name": "Payment", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.cancelPayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.cancelPayment" - } - }, - { - "id": 3497, - "name": "capturePayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3498, - "name": "capturePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3499, - "name": "payment", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment.ts", - "qualifiedName": "Payment" - }, - "name": "Payment", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.capturePayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.capturePayment" - } - }, - { - "id": 3475, - "name": "createPayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3476, - "name": "createPayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3477, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of this argument is meant to be temporary and once the previous method signature\nwill be removed, the type will only be PaymentContext instead of Cart & PaymentContext" - } - ] - }, - "type": { - "type": "intersection", - "types": [ - { + "type": { "type": "reference", "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.NextFunction" }, - "name": "Cart", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3353, - "name": "PaymentContext", - "package": "@medusajs/medusa" + "name": "NextFunction", + "package": "@types/express", + "qualifiedName": "e.NextFunction" } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3368, - "name": "PaymentSessionResponse", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.createPayment" - } - }, - { - "id": 3478, - "name": "createPayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use " - }, - { - "kind": "code", - "text": "`createPayment(context: Cart & PaymentContext): Promise`" - }, - { - "kind": "text", - "text": " instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3479, - "name": "cart", - "variant": "param", - "kind": 32768, - "flags": {}, + } + ], "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.createPayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.createPayment" - } - }, - { - "id": 3507, - "name": "deletePayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3508, - "name": "deletePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3509, - "name": "paymentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSession" - }, - "name": "PaymentSession", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { "type": "intrinsic", "name": "void" } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.deletePayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.deletePayment" - } - }, - { - "id": 3466, - "name": "getIdentifier", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true - }, - "signatures": [ - { - "id": 3467, - "name": "getIdentifier", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.getIdentifier" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.getIdentifier" - } - }, - { - "id": 3468, - "name": "getPaymentData", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3469, - "name": "getPaymentData", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "parameters": [ - { - "id": 3470, - "name": "paymentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSession" - }, - "name": "PaymentSession", - "package": "@medusajs/medusa" - } } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.getPaymentData" - } + ] } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.getPaymentData" } - }, - { - "id": 3513, - "name": "getStatus", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3514, - "name": "getStatus", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3515, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSessionStatus" - }, - "name": "PaymentSessionStatus", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.getStatus" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.getStatus" - } - }, - { - "id": 3500, - "name": "refundPayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3501, - "name": "refundPayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3502, - "name": "payment", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment.ts", - "qualifiedName": "Payment" - }, - "name": "Payment", - "package": "@medusajs/medusa" - } - }, - { - "id": 3503, - "name": "refundAmount", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.refundPayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.refundPayment" - } - }, - { - "id": 3480, - "name": "retrievePayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3481, - "name": "retrievePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "parameters": [ - { - "id": 3482, - "name": "paymentData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.retrievePayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.retrievePayment" - } - }, - { - "id": 3510, - "name": "retrieveSavedMethods", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true - }, - "signatures": [ - { - "id": 3511, - "name": "retrieveSavedMethods", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3512, - "name": "customer", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A customer can make purchases in your store and manage their profile." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer.ts", - "qualifiedName": "Customer" - }, - "name": "Customer", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.retrieveSavedMethods" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.retrieveSavedMethods" - } - }, - { - "id": 3526, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3527, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3528, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 3529, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3530, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3530 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.shouldRetryTransaction_" - } - }, - { - "id": 3483, - "name": "updatePayment", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3484, - "name": "updatePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "it return either a PaymentSessionResponse or PaymentSessionResponse[\"session_data\"] to maintain backward compatibility" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3485, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - }, - { - "id": 3486, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of this argument is meant to be temporary and once the previous method signature\nwill be removed, the type will only be PaymentContext instead of Cart & PaymentContext" - } - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3353, - "name": "PaymentContext", - "package": "@medusajs/medusa" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3368, - "name": "PaymentSessionResponse", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.updatePayment" - } - }, - { - "id": 3487, - "name": "updatePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use " - }, - { - "kind": "code", - "text": "`updatePayment(paymentSessionData: PaymentSessionData, context: Cart & PaymentContext): Promise`" - }, - { - "kind": "text", - "text": " instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3488, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - }, - { - "id": 3489, - "name": "cart", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.updatePayment" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.updatePayment" - } - }, - { - "id": 3471, - "name": "updatePaymentData", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3472, - "name": "updatePaymentData", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [] - } - ] - }, - "parameters": [ - { - "id": 3473, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - }, - { - "id": 3474, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.updatePaymentData" - } - } - ], - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.updatePaymentData" - } - }, - { - "id": 3523, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3524, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3525, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - }, - "implementationOf": { - "type": "reference", - "target": -1, - "name": "PaymentService.withTransaction" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3462 - ] - }, - { - "title": "Properties", - "children": [ - 3521, - 3520, - 3522, - 3516, - 3517, - 3457, - 3461 - ] - }, - { - "title": "Accessors", - "children": [ - 3518 - ] - }, - { - "title": "Methods", - "children": [ - 3531, - 3490, - 3504, - 3497, - 3475, - 3507, - 3466, - 3468, - 3513, - 3500, - 3480, - 3510, - 3526, - 3483, - 3471, - 3523 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": 4905, - "name": "\"medusa-interfaces\"", - "package": "@medusajs/medusa" } ] }, { - "id": 3561, - "name": "AbstractPriceSelectionStrategy", + "id": 2680, + "name": "transformQuery", "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ + "kind": 64, + "flags": {}, + "signatures": [ { - "id": 3566, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3567, - "name": "new AbstractPriceSelectionStrategy", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 3568, - "name": "__container__", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3569, - "name": "__configModule__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3570, - "name": "__moduleDeclaration__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": 3561, - "name": "AbstractPriceSelectionStrategy", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3762, - "name": "TransactionBaseService.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3761, - "name": "TransactionBaseService.constructor" - } - }, - { - "id": 3587, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ + "id": 2681, + "name": "transformQuery", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - } - }, - { - "id": 3586, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - } - }, - { - "id": 3588, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - } - }, - { - "id": 3582, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - } - }, - { - "id": 3583, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" + "kind": "text", + "text": "Middleware that transform the query input for the admin end points" } ] }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" + "typeParameter": [ + { + "id": 2682, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reference", + "target": 3901, + "name": "RequestQueryFields", + "package": "@medusajs/medusa" + } + }, + { + "id": 2683, + "name": "TEntity", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", + "qualifiedName": "BaseEntity" + }, + "name": "BaseEntity", + "package": "@medusajs/medusa" + } + } + ], + "parameters": [ + { + "id": 2684, + "name": "plainToClass", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3984, + "typeArguments": [ + { + "type": "reference", + "target": 2682, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "ClassConstructor", + "package": "@medusajs/medusa" + } + }, + { + "id": 2685, + "name": "queryConfig", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3892, + "typeArguments": [ + { + "type": "reference", + "target": 2683, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "QueryConfig", + "package": "@medusajs/medusa" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "allowedFields" + }, + { + "type": "literal", + "value": "allowedRelations" + } + ] + } + ], + "name": "Omit", + "package": "typescript" + } + }, + { + "id": 2686, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/class-validator/types/validation/ValidatorOptions.d.ts", + "qualifiedName": "ValidatorOptions" + }, + "name": "ValidatorOptions", + "package": "class-validator" + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 2687, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2688, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2689, + "name": "req", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Request" + }, + "name": "Request", + "package": "@types/express", + "qualifiedName": "e.Request" + } + }, + { + "id": 2690, + "name": "res", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Response" + }, + "name": "Response", + "package": "@types/express", + "qualifiedName": "e.Response" + } + }, + { + "id": 2691, + "name": "next", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.NextFunction" + }, + "name": "NextFunction", + "package": "@types/express", + "qualifiedName": "e.NextFunction" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ] + }, + { + "id": 2692, + "name": "transformStoreQuery", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2693, + "name": "transformStoreQuery", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Middleware that transform the query input for the store endpoints" + } + ] + }, + "typeParameter": [ + { + "id": 2694, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reference", + "target": 3901, + "name": "RequestQueryFields", + "package": "@medusajs/medusa" + } + }, + { + "id": 2695, + "name": "TEntity", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", + "qualifiedName": "BaseEntity" + }, + "name": "BaseEntity", + "package": "@medusajs/medusa" + } + } + ], + "parameters": [ + { + "id": 2696, + "name": "plainToClass", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3984, + "typeArguments": [ + { + "type": "reference", + "target": 2694, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "ClassConstructor", + "package": "@medusajs/medusa" + } + }, + { + "id": 2697, + "name": "queryConfig", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 3892, + "typeArguments": [ + { + "type": "reference", + "target": 2695, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "QueryConfig", + "package": "@medusajs/medusa" + } + }, + { + "id": 2698, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/class-validator/types/validation/ValidatorOptions.d.ts", + "qualifiedName": "ValidatorOptions" + }, + "name": "ValidatorOptions", + "package": "class-validator" + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 2699, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2700, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2701, + "name": "req", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Request" + }, + "name": "Request", + "package": "@types/express", + "qualifiedName": "e.Request" + } + }, + { + "id": 2702, + "name": "res", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Response" + }, + "name": "Response", + "package": "@types/express", + "qualifiedName": "e.Response" + } + }, + { + "id": 2703, + "name": "next", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.NextFunction" + }, + "name": "NextFunction", + "package": "@types/express", + "qualifiedName": "e.NextFunction" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ] + }, + { + "id": 5, + "name": "AdminPostAnalyticsConfigReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 6, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 7, + "name": "new AdminPostAnalyticsConfigReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 5, + "name": "AdminPostAnalyticsConfigReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 8, + "name": "opt_out", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" } }, { - "id": 3562, - "name": "_isPriceSelectionStrategy", + "id": 9, + "name": "anonymize", "variant": "declaration", "kind": 1024, "flags": { - "isStatic": true + "isOptional": true }, "type": { "type": "intrinsic", "name": "boolean" }, - "defaultValue": "true" - }, - { - "id": 3584, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 3585, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - } - }, - { - "id": 3597, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3598, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 3599, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 3600, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 3601, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3602, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3603, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3604, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 3605, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 3606, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3607, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3608, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3609, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3610, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3611, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3612, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - } - }, - { - "id": 3571, - "name": "calculateVariantPrice", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3572, - "name": "calculateVariantPrice", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Calculate the original and discount price for a given variant in a set of\ncircumstances described in the context." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "pricing details in an object containing the calculated lowest price,\nthe default price an all valid prices for the given variant" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3573, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 3574, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3577, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3576, - "name": "taxRates", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4910, - "name": "TaxServiceRate", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 3575, - "name": "variantId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3577, - 3576, - 3575 - ] - } - ] - } - } - } - }, - { - "id": 3578, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Details relevant to determine the correct pricing of the variant" - } - ] - }, - "type": { - "type": "reference", - "target": 3613, - "name": "PriceSelectionContext", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es2015.collection.d.ts", - "qualifiedName": "Map" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 3629, - "name": "PriceSelectionResult", - "package": "@medusajs/medusa" - } - ], - "name": "Map", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3549, - "name": "IPriceSelectionStrategy.calculateVariantPrice" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3548, - "name": "IPriceSelectionStrategy.calculateVariantPrice" - } - }, - { - "id": 3579, - "name": "onVariantsPricesUpdate", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true - }, - "signatures": [ - { - "id": 3580, - "name": "onVariantsPricesUpdate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Notify price selection strategy that variants prices have been updated." - } - ] - }, - "parameters": [ - { - "id": 3581, - "name": "variantIds", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ids of the updated variants" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3556, - "name": "IPriceSelectionStrategy.onVariantsPricesUpdate" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3555, - "name": "IPriceSelectionStrategy.onVariantsPricesUpdate" - } - }, - { - "id": 3592, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3593, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3594, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 3595, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3596, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3596 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - }, - { - "id": 3589, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3590, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3591, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - }, - "implementationOf": { - "type": "reference", - "target": 3559, - "name": "IPriceSelectionStrategy.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - }, - "implementationOf": { - "type": "reference", - "target": 3558, - "name": "IPriceSelectionStrategy.withTransaction" - } - }, - { - "id": 3563, - "name": "isPriceSelectionStrategy", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "signatures": [ - { - "id": 3564, - "name": "isPriceSelectionStrategy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3565, - "name": "object", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] + "defaultValue": "false" } ], "groups": [ { "title": "Constructors", "children": [ - 3566 + 6 ] }, { "title": "Properties", "children": [ - 3587, - 3586, - 3588, - 3582, - 3583, - 3562 + 8, + 9 ] - }, - { - "title": "Accessors", - "children": [ - 3584 - ] - }, - { - "title": "Methods", - "children": [ - 3597, - 3571, - 3579, - 3592, - 3589, - 3563 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": 3547, - "name": "IPriceSelectionStrategy", - "package": "@medusajs/medusa" } ] }, { - "id": 3643, - "name": "AbstractTaxCalculationStrategy", + "id": 1, + "name": "AdminAnalyticsConfigRes", "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 3648, - "name": "constructor", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2, + "name": "__type", "variant": "declaration", - "kind": 512, - "flags": { - "isProtected": true - }, - "signatures": [ + "kind": 65536, + "flags": {}, + "children": [ { - "id": 3649, - "name": "new AbstractTaxCalculationStrategy", - "variant": "signature", - "kind": 16384, + "id": 3, + "name": "analytics_config", + "variant": "declaration", + "kind": 1024, "flags": {}, - "parameters": [ - { - "id": 3650, - "name": "__container__", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3651, - "name": "__configModule__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3652, - "name": "__moduleDeclaration__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], "type": { "type": "reference", - "target": 3643, - "name": "AbstractTaxCalculationStrategy", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/analytics-config.ts", + "qualifiedName": "AnalyticsConfig" + }, + "name": "AnalyticsConfig", "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3762, - "name": "TransactionBaseService.constructor" } } ], - "inheritedFrom": { - "type": "reference", - "target": 3761, - "name": "TransactionBaseService.constructor" - } - }, + "groups": [ + { + "title": "Properties", + "children": [ + 3 + ] + } + ] + } + } + }, + { + "id": 4, + "name": "AdminAnalyticsConfigDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 10, + "name": "AdminPostAnalyticsConfigAnalyticsConfigReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ { - "id": 3663, - "name": "__configModule__", + "id": 11, + "name": "constructor", "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - } - }, - { - "id": 3662, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - } - }, - { - "id": 3664, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - } - }, - { - "id": 3658, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - } - }, - { - "id": 3659, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 12, + "name": "new AdminPostAnalyticsConfigAnalyticsConfigReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" + "target": 10, + "name": "AdminPostAnalyticsConfigAnalyticsConfigReq", + "package": "@medusajs/medusa" } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - } + } + ] }, { - "id": 3644, - "name": "_isTaxCalculationStrategy", + "id": 13, + "name": "opt_out", "variant": "declaration", "kind": 1024, "flags": { - "isStatic": true + "isOptional": true }, "type": { "type": "intrinsic", "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 3660, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 3661, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" } }, { - "id": 3673, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3674, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 3675, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 3676, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 3677, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3678, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3679, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3680, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 3681, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 3682, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3683, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3684, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3685, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3686, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3687, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3688, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - } - }, - { - "id": 3653, - "name": "calculate", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 3654, - "name": "calculate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Calculates the tax amount for a given set of line items under applicable\ntax conditions and calculation contexts." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the tax total" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3655, - "name": "items", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the line items to calculate the tax total for" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", - "qualifiedName": "LineItem" - }, - "name": "LineItem", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 3656, - "name": "taxLines", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the tax lines that applies to the calculation" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/line-item-tax-line.ts", - "qualifiedName": "LineItemTaxLine" - }, - "name": "LineItemTaxLine", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-method-tax-line.ts", - "qualifiedName": "ShippingMethodTaxLine" - }, - "name": "ShippingMethodTaxLine", - "package": "@medusajs/medusa" - } - ] - } - } - }, - { - "id": 3657, - "name": "calculationContext", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "other details relevant for the calculation" - } - ] - }, - "type": { - "type": "reference", - "target": 3697, - "name": "TaxCalculationContext", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "number" - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3639, - "name": "ITaxCalculationStrategy.calculate" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3638, - "name": "ITaxCalculationStrategy.calculate" - } - }, - { - "id": 3668, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3669, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3670, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 3671, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3672, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3672 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - }, - { - "id": 3665, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3666, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3667, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - } - }, - { - "id": 3645, - "name": "isTaxCalculationStrategy", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "signatures": [ - { - "id": 3646, - "name": "isTaxCalculationStrategy", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3647, - "name": "object", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3648 - ] - }, - { - "title": "Properties", - "children": [ - 3663, - 3662, - 3664, - 3658, - 3659, - 3644 - ] - }, - { - "title": "Accessors", - "children": [ - 3660 - ] - }, - { - "title": "Methods", - "children": [ - 3673, - 3653, - 3668, - 3665, - 3645 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": 3637, - "name": "ITaxCalculationStrategy", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 3711, - "name": "AbstractTaxService", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Interface to be implemented by tax provider plugins. The interface defines a\nsingle method " - }, - { - "kind": "code", - "text": "`getTaxLines`" - }, - { - "kind": "text", - "text": " that returns numerical rates to apply to line\nitems and shipping methods." - } - ] - }, - "children": [ - { - "id": 3717, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3718, - "name": "new AbstractTaxService", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 3719, - "name": "__container__", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3720, - "name": "__configModule__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3721, - "name": "__moduleDeclaration__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": 3711, - "name": "AbstractTaxService", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3762, - "name": "TransactionBaseService.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3761, - "name": "TransactionBaseService.constructor" - } - }, - { - "id": 3734, - "name": "__configModule__", + "id": 14, + "name": "anonymize", "variant": "declaration", "kind": 1024, "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - } - }, - { - "id": 3733, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - } - }, - { - "id": 3735, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - } - }, - { - "id": 3729, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - } - }, - { - "id": 3730, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - } - }, - { - "id": 3712, - "name": "_isTaxService", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true + "isOptional": true }, "type": { "type": "intrinsic", "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 3713, - "name": "identifier", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isStatic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3731, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 3732, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - } - }, - { - "id": 3744, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3745, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 3746, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 3747, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 3748, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3749, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3750, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3751, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 3752, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 3753, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3754, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3755, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3756, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3757, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3758, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3759, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - } - }, - { - "id": 3722, - "name": "getIdentifier", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true - }, - "signatures": [ - { - "id": 3723, - "name": "getIdentifier", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 3724, - "name": "getTaxLines", - "variant": "declaration", - "kind": 2048, - "flags": { - "isPublic": true, - "isAbstract": true - }, - "signatures": [ - { - "id": 3725, - "name": "getTaxLines", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the numerical tax lines for a calculation context." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "numerical tax rates that should apply to the provided calculation\n lines" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3726, - "name": "itemLines", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the line item calculation lines" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 3693, - "name": "ItemTaxCalculationLine", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 3727, - "name": "shippingLines", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 3689, - "name": "ShippingTaxCalculationLine", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 3728, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "other details relevant to the tax determination" - } - ] - }, - "type": { - "type": "reference", - "target": 3697, - "name": "TaxCalculationContext", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 4924, - "name": "ProviderTaxLine", - "package": "@medusajs/medusa" - } - } - ], - "name": "Promise", - "package": "typescript" - }, - "implementationOf": { - "type": "reference", - "target": 3707, - "name": "ITaxService.getTaxLines" - } - } - ], - "implementationOf": { - "type": "reference", - "target": 3706, - "name": "ITaxService.getTaxLines" - } - }, - { - "id": 3739, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3740, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3741, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 3742, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3743, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3743 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - }, - { - "id": 3736, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3737, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3738, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - } - }, - { - "id": 3714, - "name": "isTaxService", - "variant": "declaration", - "kind": 2048, - "flags": { - "isStatic": true - }, - "signatures": [ - { - "id": 3715, - "name": "isTaxService", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3716, - "name": "object", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3717 - ] - }, - { - "title": "Properties", - "children": [ - 3734, - 3733, - 3735, - 3729, - 3730, - 3712, - 3713 - ] - }, - { - "title": "Accessors", - "children": [ - 3731 - ] - }, - { - "title": "Methods", - "children": [ - 3744, - 3722, - 3724, - 3739, - 3736, - 3714 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedTypes": [ - { - "type": "reference", - "target": 3705, - "name": "ITaxService", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 4437, - "name": "AdditionalItem", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4438, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4439, - "name": "new AdditionalItem", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4437, - "name": "AdditionalItem", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4441, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4440, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" } } ], @@ -15760,189 +2552,21 @@ { "title": "Constructors", "children": [ - 4438 + 11 ] }, { "title": "Properties", "children": [ - 4441, - 4440 + 13, + 14 ] } ] }, { - "id": 4466, - "name": "AdditionalItem", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4467, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4468, - "name": "new AdditionalItem", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4466, - "name": "AdditionalItem", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4470, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4469, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4467 - ] - }, - { - "title": "Properties", - "children": [ - 4470, - 4469 - ] - } - ] - }, - { - "id": 4808, - "name": "AdditionalItem", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4809, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4810, - "name": "new AdditionalItem", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4808, - "name": "AdditionalItem", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4812, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity of the variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4811, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4809 - ] - }, - { - "title": "Properties", - "children": [ - 4812, - 4811 - ] - } - ] - }, - { - "id": 3949, - "name": "AddressCreatePayload", + "id": 21, + "name": "AdminPostAuthReq", "variant": "declaration", "kind": 128, "flags": {}, @@ -15950,21 +2574,21 @@ "summary": [ { "kind": "text", - "text": "Address fields used when creating an address." + "text": "The admin's credentials used to log in." } ] }, "children": [ { - "id": 3950, + "id": 22, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 3951, - "name": "new AddressCreatePayload", + "id": 23, + "name": "new AdminPostAuthReq", "variant": "signature", "kind": 16384, "flags": {}, @@ -15972,886 +2596,21 @@ "summary": [ { "kind": "text", - "text": "Address fields used when creating an address." + "text": "The admin's credentials used to log in." } ] }, "type": { "type": "reference", - "target": 3949, - "name": "AddressCreatePayload", + "target": 21, + "name": "AdminPostAuthReq", "package": "@medusajs/medusa" } } ] }, { - "id": 3957, - "name": "address_1", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Address line 1" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3958, - "name": "address_2", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Address line 2" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3959, - "name": "city", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "City" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3956, - "name": "company", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3960, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The 2 character ISO code of the country in lower case" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3952, - "name": "first_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "First name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3953, - "name": "last_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3955, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional key-value map with additional details" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 3954, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Phone Number" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3962, - "name": "postal_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postal Code" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3961, - "name": "province", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Province" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3950 - ] - }, - { - "title": "Properties", - "children": [ - 3957, - 3958, - 3959, - 3956, - 3960, - 3952, - 3953, - 3955, - 3954, - 3962, - 3961 - ] - } - ] - }, - { - "id": 3935, - "name": "AddressPayload", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Address fields used when creating/updating an address." - } - ] - }, - "children": [ - { - "id": 3936, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 3937, - "name": "new AddressPayload", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Address fields used when creating/updating an address." - } - ] - }, - "type": { - "type": "reference", - "target": 3935, - "name": "AddressPayload", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 3943, - "name": "address_1", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Address line 1" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3944, - "name": "address_2", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Address line 2" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3945, - "name": "city", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "City" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3942, - "name": "company", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Company" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3946, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The 2 character ISO code of the country in lower case" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3938, - "name": "first_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "First name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3939, - "name": "last_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3941, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional key-value map with additional details" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3940, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Phone Number" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3948, - "name": "postal_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postal Code" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3947, - "name": "province", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Province" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3936 - ] - }, - { - "title": "Properties", - "children": [ - 3943, - 3944, - 3945, - 3942, - 3946, - 3938, - 3939, - 3941, - 3940, - 3948, - 3947 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2276, - "name": "StorePostCustomersCustomerAddressesAddressReq" - } - ] - }, - { - "id": 264, - "name": "AdminCreateCondition", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Details of the discount condition to create." - } - ] - }, - "children": [ - { - "id": 265, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 266, - "name": "new AdminCreateCondition", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 264, - "name": "AdminCreateCondition", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4353, - "name": "AdminUpsertConditionsReq.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4352, - "name": "AdminUpsertConditionsReq.constructor" - } - }, - { - "id": 272, - "name": "customer_groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer groups associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`customer_groups`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4358, - "name": "AdminUpsertConditionsReq.customer_groups" - } - }, - { - "id": 267, - "name": "operator", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The operator of the discount condition." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/discount-condition.ts", - "qualifiedName": "DiscountConditionOperator" - }, - "name": "DiscountConditionOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 269, - "name": "product_collections", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product collections associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_collections`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4355, - "name": "AdminUpsertConditionsReq.product_collections" - } - }, - { - "id": 271, - "name": "product_tags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product tags associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_tags`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4357, - "name": "AdminUpsertConditionsReq.product_tags" - } - }, - { - "id": 270, - "name": "product_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product types associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_types`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4356, - "name": "AdminUpsertConditionsReq.product_types" - } - }, - { - "id": 268, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The products associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`products`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4354, - "name": "AdminUpsertConditionsReq.products" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 265 - ] - }, - { - "title": "Properties", - "children": [ - 272, - 267, - 269, - 271, - 270, - 268 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4351, - "name": "AdminUpsertConditionsReq", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 2050, - "name": "AdminCreateUserRequest", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2051, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2052, - "name": "new AdminCreateUserRequest", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2050, - "name": "AdminCreateUserRequest", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2053, + "id": 24, "name": "email", "variant": "declaration", "kind": 1024, @@ -16860,7 +2619,7 @@ "summary": [ { "kind": "text", - "text": "The User's email." + "text": "The user's email." } ] }, @@ -16870,49 +2629,7 @@ } }, { - "id": 2054, - "name": "first_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The first name of the User." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2055, - "name": "last_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last name of the User." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2057, + "id": 25, "name": "password", "variant": "declaration", "kind": 1024, @@ -16921,7 +2638,222 @@ "summary": [ { "kind": "text", - "text": "The User's password." + "text": "The user's password." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 22 + ] + }, + { + "title": "Properties", + "children": [ + 24, + 25 + ] + } + ] + }, + { + "id": 15, + "name": "AdminAuthRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 16, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 17, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "User details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/user.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 17 + ] + } + ] + } + } + }, + { + "id": 18, + "name": "AdminBearerAuthRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The access token of the user, if they're authenticated successfully." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 19, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 20, + "name": "access_token", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Access token that can be used to send authenticated requests." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 20 + ] + } + ] + } + } + }, + { + "id": 33, + "name": "AdminPostBatchesReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the batch job to create." + } + ] + }, + "children": [ + { + "id": 34, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 35, + "name": "new AdminPostBatchesReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the batch job to create." + } + ] + }, + "type": { + "type": "reference", + "target": 33, + "name": "AdminPostBatchesReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 36, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of batch job to start, which is defined by the `batchType` property of the associated batch job strategy." } ] }, @@ -16931,99 +2863,42 @@ } }, { - "id": 2056, - "name": "role", + "id": 37, + "name": "context", "variant": "declaration", "kind": 1024, - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The role assigned to the user. These roles don't provide any different privileges." + "text": "Additional infomration regarding the batch to be used for processing." } ] }, "type": { "type": "reference", "target": { - "sourceFileName": "../../../packages/medusa/src/models/user.ts", - "qualifiedName": "UserRoles" + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" }, - "name": "UserRoles", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2051 - ] - }, - { - "title": "Properties", - "children": [ - 2053, - 2054, - 2055, - 2057, - 2056 - ] - } - ] - }, - { - "id": 150, - "name": "AdminDeleteCustomerGroupsGroupCustomerBatchReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customers to remove from the customer group." - } - ] - }, - "children": [ - { - "id": 151, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 152, - "name": "new AdminDeleteCustomerGroupsGroupCustomerBatchReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customers to remove from the customer group." - } - ] + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" }, - "type": { - "type": "reference", - "target": 150, - "name": "AdminDeleteCustomerGroupsGroupCustomerBatchReq", - "package": "@medusajs/medusa" + { + "type": "intrinsic", + "name": "unknown" } - } - ] + ], + "name": "Record", + "package": "typescript" + } }, { - "id": 153, - "name": "customer_ids", + "id": 38, + "name": "dry_run", "variant": "declaration", "kind": 1024, "flags": {}, @@ -17031,1728 +2906,183 @@ "summary": [ { "kind": "text", - "text": "The ids of the customers to remove" + "text": "Set a batch job in dry_run mode, which would delay executing the batch job until it's confirmed." } ] }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4328, - "name": "CustomerGroupsBatchCustomer", - "package": "@medusajs/medusa" - } - } + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" } ], "groups": [ { "title": "Constructors", "children": [ - 151 + 34 ] }, { "title": "Properties", "children": [ - 153 + 36, + 37, + 38 ] } ] }, { - "id": 375, - "name": "AdminDeleteDiscountsDiscountConditionsConditionBatchParams", + "id": 26, + "name": "AdminBatchJobRes", "variant": "declaration", - "kind": 128, + "kind": 2097152, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." + "text": "The batch job's details." } + ], + "modifierTags": [ + "@interface" ] }, - "children": [ - { - "id": 376, - "name": "constructor", + "type": { + "type": "reflection", + "declaration": { + "id": 27, + "name": "__type", "variant": "declaration", - "kind": 512, + "kind": 65536, "flags": {}, - "signatures": [ + "children": [ { - "id": 377, - "name": "new AdminDeleteDiscountsDiscountConditionsConditionBatchParams", - "variant": "signature", - "kind": 16384, + "id": 28, + "name": "batch_job", + "variant": "declaration", + "kind": 1024, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Batch job details." + } + ] + }, "type": { "type": "reference", - "target": 375, - "name": "AdminDeleteDiscountsDiscountConditionsConditionBatchParams", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/batch-job.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" } } ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 378, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 379, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 376 - ] - }, - { - "title": "Properties", - "children": [ - 378, - 379 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 380, - "name": "AdminDeleteDiscountsDiscountConditionsConditionBatchReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The resources to remove." - } - ] - }, - "children": [ - { - "id": 381, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ + "groups": [ { - "id": 382, - "name": "new AdminDeleteDiscountsDiscountConditionsConditionBatchReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The resources to remove." - } - ] - }, - "type": { - "type": "reference", - "target": 380, - "name": "AdminDeleteDiscountsDiscountConditionsConditionBatchReq", - "package": "@medusajs/medusa" - } + "title": "Properties", + "children": [ + 28 + ] } ] - }, - { - "id": 383, - "name": "resources", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The resources to be removed from the discount condition" - } - ] + } + } + }, + { + "id": 29, + "name": "AdminBatchJobListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 384, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 385, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The id of the item" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" + { + "type": "reflection", + "declaration": { + "id": 30, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 31, + "name": "batch_jobs", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of batch job details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/batch-job.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" } } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 385 - ] - } - ] - } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 31 + ] + } + ] } } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 381 - ] - }, - { - "title": "Properties", - "children": [ - 383 - ] - } - ] - }, - { - "id": 284, - "name": "AdminDeleteDiscountsDiscountConditionsConditionParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } ] - }, - "children": [ - { - "id": 285, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 286, - "name": "new AdminDeleteDiscountsDiscountConditionsConditionParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 284, - "name": "AdminDeleteDiscountsDiscountConditionsConditionParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 287, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 288, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 285 - ] - }, - { - "title": "Properties", - "children": [ - 287, - 288 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] + } }, { - "id": 1099, - "name": "AdminDeletePriceListPricesPricesReq", + "id": 32, + "name": "defaultAdminBatchFields", "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the prices to delete." - } - ] + "kind": 32, + "flags": { + "isConst": true }, - "children": [ - { - "id": 1100, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1101, - "name": "new AdminDeletePriceListPricesPricesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the prices to delete." - } - ] - }, - "type": { - "type": "reference", - "target": 1099, - "name": "AdminDeletePriceListPricesPricesReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1102, - "name": "price_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the prices to delete." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1100 - ] - }, - { - "title": "Properties", - "children": [ - 1102 - ] - } - ] - }, - { - "id": 1103, - "name": "AdminDeletePriceListsPriceListProductsPricesBatchReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products' prices to delete." - } - ] }, - "children": [ - { - "id": 1104, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1105, - "name": "new AdminDeletePriceListsPriceListProductsPricesBatchReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products' prices to delete." - } - ] - }, - "type": { - "type": "reference", - "target": 1103, - "name": "AdminDeletePriceListsPriceListProductsPricesBatchReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1106, - "name": "product_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the products to delete their associated prices." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1104 - ] - }, - { - "title": "Properties", - "children": [ - 1106 - ] - } - ] - }, - { - "id": 1231, - "name": "AdminDeleteProductCategoriesCategoryProductsBatchParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1232, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1233, - "name": "new AdminDeleteProductCategoriesCategoryProductsBatchParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1231, - "name": "AdminDeleteProductCategoriesCategoryProductsBatchParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 1234, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 1235, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1232 - ] - }, - { - "title": "Properties", - "children": [ - 1234, - 1235 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1227, - "name": "AdminDeleteProductCategoriesCategoryProductsBatchReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to delete from the product category." - } - ] - }, - "children": [ - { - "id": 1228, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1229, - "name": "new AdminDeleteProductCategoriesCategoryProductsBatchReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to delete from the product category." - } - ] - }, - "type": { - "type": "reference", - "target": 1227, - "name": "AdminDeleteProductCategoriesCategoryProductsBatchReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1230, - "name": "product_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the products to delete from the product category." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4558, - "name": "ProductBatchProductCategory", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1228 - ] - }, - { - "title": "Properties", - "children": [ - 1230 - ] - } - ] - }, - { - "id": 105, - "name": "AdminDeleteProductsFromCollectionReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to remove from the collection." - } - ] - }, - "children": [ - { - "id": 106, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 107, - "name": "new AdminDeleteProductsFromCollectionReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to remove from the collection." - } - ] - }, - "type": { - "type": "reference", - "target": 105, - "name": "AdminDeleteProductsFromCollectionReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 108, - "name": "product_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of Product IDs to remove from the Product Collection." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 106 - ] - }, - { - "title": "Properties", - "children": [ - 108 - ] - } - ] - }, - { - "id": 1515, - "name": "AdminDeletePublishableApiKeySalesChannelsBatchReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the sales channels to remove from the publishable API key." - } - ] - }, - "children": [ - { - "id": 1516, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1517, - "name": "new AdminDeletePublishableApiKeySalesChannelsBatchReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the sales channels to remove from the publishable API key." - } - ] - }, - "type": { - "type": "reference", - "target": 1515, - "name": "AdminDeletePublishableApiKeySalesChannelsBatchReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1518, - "name": "sales_channel_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the sales channels to remove from the publishable API key" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4680, - "name": "ProductBatchSalesChannel", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1516 - ] - }, - { - "title": "Properties", - "children": [ - 1518 - ] - } - ] - }, - { - "id": 1714, - "name": "AdminDeleteSalesChannelsChannelProductsBatchReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to delete from the sales channel." - } - ] - }, - "children": [ - { - "id": 1715, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1716, - "name": "new AdminDeleteSalesChannelsChannelProductsBatchReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to delete from the sales channel." - } - ] - }, - "type": { - "type": "reference", - "target": 1714, - "name": "AdminDeleteSalesChannelsChannelProductsBatchReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1717, - "name": "product_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the products to remove from the sales channel." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4680, - "name": "ProductBatchSalesChannel", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1715 - ] - }, - { - "title": "Properties", - "children": [ - 1717 - ] - } - ] - }, - { - "id": 1744, - "name": "AdminDeleteSalesChannelsChannelStockLocationsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1745, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1746, - "name": "new AdminDeleteSalesChannelsChannelStockLocationsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1744, - "name": "AdminDeleteSalesChannelsChannelStockLocationsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1747, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the stock location" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1745 - ] - }, - { - "title": "Properties", - "children": [ - 1747 - ] - } - ] - }, - { - "id": 1925, - "name": "AdminDeleteTaxRatesTaxRateProductTypesParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1926, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1927, - "name": "new AdminDeleteTaxRatesTaxRateProductTypesParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1925, - "name": "AdminDeleteTaxRatesTaxRateProductTypesParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1928, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1929, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1926 - ] - }, - { - "title": "Properties", - "children": [ - 1928, - 1929 - ] - } - ] - }, - { - "id": 1921, - "name": "AdminDeleteTaxRatesTaxRateProductTypesReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product types to remove from the tax rates." - } - ] - }, - "children": [ - { - "id": 1922, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1923, - "name": "new AdminDeleteTaxRatesTaxRateProductTypesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product types to remove from the tax rates." - } - ] - }, - "type": { - "type": "reference", - "target": 1921, - "name": "AdminDeleteTaxRatesTaxRateProductTypesReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1924, - "name": "product_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the product types to remove their association with this tax rate." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1922 - ] - }, - { - "title": "Properties", - "children": [ - 1924 - ] - } - ] - }, - { - "id": 1934, - "name": "AdminDeleteTaxRatesTaxRateProductsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1935, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1936, - "name": "new AdminDeleteTaxRatesTaxRateProductsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1934, - "name": "AdminDeleteTaxRatesTaxRateProductsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1937, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1938, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1935 - ] - }, - { - "title": "Properties", - "children": [ - 1937, - 1938 - ] - } - ] - }, - { - "id": 1930, - "name": "AdminDeleteTaxRatesTaxRateProductsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to remove their associated with the tax rate." - } - ] - }, - "children": [ - { - "id": 1931, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1932, - "name": "new AdminDeleteTaxRatesTaxRateProductsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to remove their associated with the tax rate." - } - ] - }, - "type": { - "type": "reference", - "target": 1930, - "name": "AdminDeleteTaxRatesTaxRateProductsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1933, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the products to remove their association with this tax rate." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1931 - ] - }, - { - "title": "Properties", - "children": [ - 1933 - ] - } - ] - }, - { - "id": 1943, - "name": "AdminDeleteTaxRatesTaxRateShippingOptionsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1944, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1945, - "name": "new AdminDeleteTaxRatesTaxRateShippingOptionsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1943, - "name": "AdminDeleteTaxRatesTaxRateShippingOptionsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1946, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1947, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1944 - ] - }, - { - "title": "Properties", - "children": [ - 1946, - 1947 - ] - } - ] - }, - { - "id": 1939, - "name": "AdminDeleteTaxRatesTaxRateShippingOptionsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the shipping options to remove their associate with the tax rate." - } - ] - }, - "children": [ - { - "id": 1940, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1941, - "name": "new AdminDeleteTaxRatesTaxRateShippingOptionsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the shipping options to remove their associate with the tax rate." - } - ] - }, - "type": { - "type": "reference", - "target": 1939, - "name": "AdminDeleteTaxRatesTaxRateShippingOptionsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1942, - "name": "shipping_options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the shipping options to remove their association with this tax rate." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1940 - ] - }, - { - "title": "Properties", - "children": [ - 1942 - ] - } - ] - }, - { - "id": 2017, - "name": "AdminDeleteUploadsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the file to delete." - } - ] - }, - "children": [ - { - "id": 2018, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2019, - "name": "new AdminDeleteUploadsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the file to delete." - } - ] - }, - "type": { - "type": "reference", - "target": 2017, - "name": "AdminDeleteUploadsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2020, - "name": "file_key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "key of the file to delete. This is obtained when you first uploaded the file, or by the file service if you used it directly." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2018 - ] - }, - { - "title": "Properties", - "children": [ - 2020 - ] - } - ] + "defaultValue": "..." }, { "id": 39, @@ -18791,6 +3121,46 @@ } ] }, + { + "id": 42, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "10" + }, + { + "id": 43, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, { "id": 44, "name": "expand", @@ -18833,46 +3203,6 @@ "name": "string" } }, - { - "id": 42, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "10" - }, - { - "id": 43, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, { "id": 46, "name": "order", @@ -18913,10 +3243,10 @@ { "title": "Properties", "children": [ - 44, - 45, 42, 43, + 44, + 45, 46 ] } @@ -18976,282 +3306,6 @@ "name": "AdminGetBatchPaginationParams.constructor" } }, - { - "id": 56, - "name": "canceled_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the batch jobs' " - }, - { - "kind": "code", - "text": "`canceled_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 54, - "name": "completed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the batch jobs' " - }, - { - "kind": "code", - "text": "`completed_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 52, - "name": "confirmed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the batch jobs' " - }, - { - "kind": "code", - "text": "`confirmed_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 57, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the batch jobs' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 61, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 44, - "name": "AdminGetBatchPaginationParams.expand" - } - }, - { - "id": 55, - "name": "failed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the batch jobs' " - }, - { - "kind": "code", - "text": "`failed_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 62, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 45, - "name": "AdminGetBatchPaginationParams.fields" - } - }, - { - "id": 50, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter batch jobs by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, { "id": 59, "name": "limit", @@ -19302,6 +3356,58 @@ "name": "AdminGetBatchPaginationParams.offset" } }, + { + "id": 61, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 44, + "name": "AdminGetBatchPaginationParams.expand" + } + }, + { + "id": 62, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 45, + "name": "AdminGetBatchPaginationParams.fields" + } + }, { "id": 63, "name": "order", @@ -19336,6 +3442,103 @@ "name": "AdminGetBatchPaginationParams.order" } }, + { + "id": 50, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter batch jobs by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 51, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Types to filter batch jobs by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 52, + "name": "confirmed_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the batch jobs' " + }, + { + "kind": "code", + "text": "`confirmed_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, { "id": 53, "name": "pre_processed_at", @@ -19369,7 +3572,7 @@ }, { "type": "reference", - "target": 3911, + "target": 3918, "name": "DateComparisonOperator", "package": "@medusajs/medusa" } @@ -19377,8 +3580,8 @@ } }, { - "id": 51, - "name": "type", + "id": 54, + "name": "completed_at", "variant": "declaration", "kind": 1024, "flags": { @@ -19388,16 +3591,143 @@ "summary": [ { "kind": "text", - "text": "Types to filter batch jobs by." + "text": "Date filters to apply on the batch jobs' " + }, + { + "kind": "code", + "text": "`completed_at`" + }, + { + "kind": "text", + "text": " date." } ] }, "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 55, + "name": "failed_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the batch jobs' " + }, + { + "kind": "code", + "text": "`failed_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 56, + "name": "canceled_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the batch jobs' " + }, + { + "kind": "code", + "text": "`canceled_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 57, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the batch jobs' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" } }, { @@ -19426,7 +3756,7 @@ }, "type": { "type": "reference", - "target": 3911, + "target": 3918, "name": "DateComparisonOperator", "package": "@medusajs/medusa" } @@ -19442,19 +3772,19 @@ { "title": "Properties", "children": [ - 56, - 54, - 52, - 57, - 61, - 55, - 62, - 50, 59, 60, + 61, + 62, 63, - 53, + 50, 51, + 52, + 53, + 54, + 55, + 56, + 57, 58 ] } @@ -19468,6 +3798,515 @@ } ] }, + { + "id": 78, + "name": "AdminPostProductsToCollectionReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to add to the collection." + } + ] + }, + "children": [ + { + "id": 79, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 80, + "name": "new AdminPostProductsToCollectionReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to add to the collection." + } + ] + }, + "type": { + "type": "reference", + "target": 78, + "name": "AdminPostProductsToCollectionReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 81, + "name": "product_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of Product IDs to add to the Product Collection." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 79 + ] + }, + { + "title": "Properties", + "children": [ + 81 + ] + } + ] + }, + { + "id": 82, + "name": "AdminPostCollectionsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection's details." + } + ] + }, + "children": [ + { + "id": 83, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 84, + "name": "new AdminPostCollectionsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection's details." + } + ] + }, + "type": { + "type": "reference", + "target": 82, + "name": "AdminPostCollectionsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 85, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the collection." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 86, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional handle to be used in slugs. If none is provided, the kebab-case version of the title will be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 87, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 83 + ] + }, + { + "title": "Properties", + "children": [ + 85, + 86, + 87 + ] + } + ] + }, + { + "id": 64, + "name": "defaultAdminCollectionsFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 65, + "name": "defaultAdminCollectionsRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 66, + "name": "AdminCollectionsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 67, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 68, + "name": "collections", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "an array of collection details" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-collection.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 68 + ] + } + ] + } + } + ] + } + }, + { + "id": 69, + "name": "AdminCollectionsDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 70, + "name": "AdminDeleteProductsFromCollectionRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Deletion operation details" + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 71, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 72, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the collection" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 73, + "name": "object", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of object the removal was executed on" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "product-collection" + }, + { + "id": 74, + "name": "removed_products", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the products removed from the collection" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 72, + 73, + 74 + ] + } + ] + } + } + }, + { + "id": 75, + "name": "AdminCollectionsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The collection's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 76, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 77, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product Collection details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-collection.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 77 + ] + } + ] + } + } + }, { "id": 88, "name": "AdminGetCollectionsPaginationParams", @@ -19616,110 +4455,6 @@ "name": "AdminGetCollectionsPaginationParams.constructor" } }, - { - "id": 98, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the product collections' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 100, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the product collections' " - }, - { - "kind": "code", - "text": "`deleted_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 102, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter product collections by their associated discount condition's ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 97, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Handle to filter product collections by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, { "id": 103, "name": "limit", @@ -19770,27 +4505,6 @@ "name": "AdminGetCollectionsPaginationParams.offset" } }, - { - "id": 101, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Term to search product collections by their title and handle." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, { "id": 96, "name": "title", @@ -19812,6 +4526,58 @@ "name": "string" } }, + { + "id": 97, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Handle to filter product collections by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 98, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the product collections' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, { "id": 99, "name": "updated_at", @@ -19838,10 +4604,83 @@ }, "type": { "type": "reference", - "target": 3911, + "target": 3918, "name": "DateComparisonOperator", "package": "@medusajs/medusa" } + }, + { + "id": 100, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the product collections' " + }, + { + "kind": "code", + "text": "`deleted_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 101, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Term to search product collections by their title and handle." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 102, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter product collections by their associated discount condition's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } } ], "groups": [ @@ -19854,15 +4693,15 @@ { "title": "Properties", "children": [ - 98, - 100, - 102, - 97, 103, 104, - 101, 96, - 99 + 97, + 98, + 99, + 100, + 101, + 102 ] } ], @@ -19876,8 +4715,8 @@ ] }, { - "id": 121, - "name": "AdminGetCurrenciesParams", + "id": 105, + "name": "AdminDeleteProductsFromCollectionReq", "variant": "declaration", "kind": 128, "flags": {}, @@ -19885,8175 +4724,21 @@ "summary": [ { "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved currencies." + "text": "The details of the products to remove from the collection." } ] }, "children": [ { - "id": 122, + "id": 106, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 123, - "name": "new AdminGetCurrenciesParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 121, - "name": "AdminGetCurrenciesParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3970, - "name": "FindPaginationParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3969, - "name": "FindPaginationParams.constructor" - } - }, - { - "id": 124, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Code to filter currencies by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 125, - "name": "includes_tax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter currencies by whether they include tax." - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "text", - "text": "tax_inclusive_pricing" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 128, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": 3972, - "name": "FindPaginationParams.limit" - } - }, - { - "id": 127, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": 3971, - "name": "FindPaginationParams.offset" - } - }, - { - "id": 126, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": ".\nBy default, the returned currencies will be sorted by their " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 122 - ] - }, - { - "title": "Properties", - "children": [ - 124, - 125, - 128, - 127, - 126 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3968, - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 154, - "name": "AdminGetCustomerGroupsGroupParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 155, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 156, - "name": "new AdminGetCustomerGroupsGroupParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 154, - "name": "AdminGetCustomerGroupsGroupParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 157, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 158, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 155 - ] - }, - { - "title": "Properties", - "children": [ - 157, - 158 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 159, - "name": "AdminGetCustomerGroupsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved customer groups." - } - ] - }, - "children": [ - { - "id": 160, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 161, - "name": "new AdminGetCustomerGroupsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 159, - "name": "AdminGetCustomerGroupsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4334, - "name": "FilterableCustomerGroupProps.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4333, - "name": "FilterableCustomerGroupProps.constructor" - } - }, - { - "id": 170, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the customer groups' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4339, - "name": "FilterableCustomerGroupProps.created_at" - } - }, - { - "id": 171, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter customer groups by their associated discount condition's ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4340, - "name": "FilterableCustomerGroupProps.discount_condition_id" - } - }, - { - "id": 165, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 166, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter customer groups by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 4335, - "name": "FilterableCustomerGroupProps.id" - } - }, - { - "id": 164, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "10" - }, - { - "id": 168, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Names to filter customer groups by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4337, - "name": "FilterableCustomerGroupProps.name" - } - }, - { - "id": 163, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 162, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 167, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search customer groups by their name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4336, - "name": "FilterableCustomerGroupProps.q" - } - }, - { - "id": 169, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the customer groups' " - }, - { - "kind": "code", - "text": "`update_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4338, - "name": "FilterableCustomerGroupProps.updated_at" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 160 - ] - }, - { - "title": "Properties", - "children": [ - 170, - 171, - 165, - 166, - 164, - 168, - 163, - 162, - 167, - 169 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4332, - "name": "FilterableCustomerGroupProps", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 193, - "name": "AdminGetCustomersParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved customers." - } - ] - }, - "children": [ - { - "id": 194, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 195, - "name": "new AdminGetCustomersParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 193, - "name": "AdminGetCustomersParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4343, - "name": "AdminListCustomerSelector.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4342, - "name": "AdminListCustomerSelector.constructor" - } - }, - { - "id": 198, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 201, - "name": "groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter customers by the customer's customer groups." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4346, - "name": "AdminListCustomerSelector.groups" - } - }, - { - "id": 200, - "name": "has_account", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter customers by whether they have an account." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 4345, - "name": "AdminListCustomerSelector.has_account" - } - }, - { - "id": 196, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n50\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "50" - }, - { - "id": 197, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 199, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term used to search customers' email, first name, last name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4344, - "name": "AdminListCustomerSelector.q" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 194 - ] - }, - { - "title": "Properties", - "children": [ - 198, - 201, - 200, - 196, - 197, - 199 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4341, - "name": "AdminListCustomerSelector", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 294, - "name": "AdminGetDiscountParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 295, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 296, - "name": "new AdminGetDiscountParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 294, - "name": "AdminGetDiscountParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 297, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 298, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 295 - ] - }, - { - "title": "Properties", - "children": [ - 297, - 298 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 299, - "name": "AdminGetDiscountsDiscountCodeParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 300, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 301, - "name": "new AdminGetDiscountsDiscountCodeParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 299, - "name": "AdminGetDiscountsDiscountCodeParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 302, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 303, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 300 - ] - }, - { - "title": "Properties", - "children": [ - 302, - 303 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 289, - "name": "AdminGetDiscountsDiscountConditionsConditionParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 290, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 291, - "name": "new AdminGetDiscountsDiscountConditionsConditionParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 289, - "name": "AdminGetDiscountsDiscountConditionsConditionParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 292, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 293, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 290 - ] - }, - { - "title": "Properties", - "children": [ - 292, - 293 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 4359, - "name": "AdminGetDiscountsDiscountRuleParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on discounts' rules." - } - ] - }, - "children": [ - { - "id": 4360, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4361, - "name": "new AdminGetDiscountsDiscountRuleParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4359, - "name": "AdminGetDiscountsDiscountRuleParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4363, - "name": "allocation", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Allocation to filter discount rules by." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/discount-rule.ts", - "qualifiedName": "AllocationType" - }, - "name": "AllocationType", - "package": "@medusajs/medusa" - } - }, - { - "id": 4362, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type to filter discount rules by." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/discount-rule.ts", - "qualifiedName": "DiscountRuleType" - }, - "name": "DiscountRuleType", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4360 - ] - }, - { - "title": "Properties", - "children": [ - 4363, - 4362 - ] - } - ] - }, - { - "id": 304, - "name": "AdminGetDiscountsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved discounts." - } - ] - }, - "children": [ - { - "id": 305, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 306, - "name": "new AdminGetDiscountsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 307, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "target": 304, - "name": "AdminGetDiscountsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" - } - }, - { - "id": 312, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).expand" - } - }, - { - "id": 313, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).fields" - } - }, - { - "id": 311, - "name": "is_disabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter discounts by whether they're disabled." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 310, - "name": "is_dynamic", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter discounts by whether they're dynamic." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 315, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).limit" - } - }, - { - "id": 314, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).offset" - } - }, - { - "id": 309, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search terms to search discounts' code fields." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 308, - "name": "rule", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter discounts by their associated rule." - } - ] - }, - "type": { - "type": "reference", - "target": 4359, - "name": "AdminGetDiscountsDiscountRuleParams", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 305 - ] - }, - { - "title": "Properties", - "children": [ - 312, - 313, - 311, - 310, - 315, - 314, - 309, - 308 - ] - } - ], - "extendedTypes": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - } - ] - }, - { - "id": 422, - "name": "AdminGetDraftOrdersParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved draft orders." - } - ] - }, - "children": [ - { - "id": 423, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 424, - "name": "new AdminGetDraftOrdersParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 422, - "name": "AdminGetDraftOrdersParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 426, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "50" - }, - { - "id": 427, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 425, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search draft orders by their display IDs and emails." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 423 - ] - }, - { - "title": "Properties", - "children": [ - 426, - 427, - 425 - ] - } - ] - }, - { - "id": 470, - "name": "AdminGetGiftCardsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved gift cards." - } - ] - }, - "children": [ - { - "id": 471, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 472, - "name": "new AdminGetGiftCardsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 470, - "name": "AdminGetGiftCardsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 473, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n50\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "50" - }, - { - "id": 474, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 475, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search gift cards by their code and display ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 471 - ] - }, - { - "title": "Properties", - "children": [ - 473, - 474, - 475 - ] - } - ] - }, - { - "id": 568, - "name": "AdminGetInventoryItemsItemLocationLevelsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 569, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 570, - "name": "new AdminGetInventoryItemsItemLocationLevelsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 568, - "name": "AdminGetInventoryItemsItemLocationLevelsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 572, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 573, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - }, - { - "id": 571, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Location IDs to filter location levels." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 569 - ] - }, - { - "title": "Properties", - "children": [ - 572, - 573, - 571 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 542, - "name": "AdminGetInventoryItemsItemParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 543, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 544, - "name": "new AdminGetInventoryItemsItemParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 542, - "name": "AdminGetInventoryItemsItemParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 545, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 546, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 543 - ] - }, - { - "title": "Properties", - "children": [ - 545, - 546 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 547, - "name": "AdminGetInventoryItemsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved inventory items." - } - ] - }, - "children": [ - { - "id": 548, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 549, - "name": "new AdminGetInventoryItemsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 550, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "target": 547, - "name": "AdminGetInventoryItemsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" - } - }, - { - "id": 564, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).expand" - } - }, - { - "id": 565, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).fields" - } - }, - { - "id": 561, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number filters to apply to inventory items' " - }, - { - "kind": "code", - "text": "`height`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "reference", - "target": 3928, - "name": "NumericalComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 558, - "name": "hs_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "String filters to apply to inventory items' " - }, - { - "kind": "code", - "text": "`hs_code`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 551, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter inventory items by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 560, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number filters to apply to inventory items' " - }, - { - "kind": "code", - "text": "`length`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "reference", - "target": 3928, - "name": "NumericalComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 567, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).limit" - } - }, - { - "id": 553, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Location IDs to filter inventory items by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 557, - "name": "material", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Materials to filter inventory items by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 556, - "name": "mid_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "MID codes to filter inventory items by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 566, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).offset" - } - }, - { - "id": 555, - "name": "origin_country", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Origin countries to filter inventory items by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 552, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search terms to search inventory items' sku, title, and description." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 563, - "name": "requires_shipping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter inventory items by whether they require shipping." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 554, - "name": "sku", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "SKUs to filter inventory items by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 559, - "name": "weight", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number filters to apply to inventory items' " - }, - { - "kind": "code", - "text": "`weight`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "reference", - "target": 3928, - "name": "NumericalComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 562, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number filters to apply to inventory items' " - }, - { - "kind": "code", - "text": "`width`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "reference", - "target": 3928, - "name": "NumericalComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 548 - ] - }, - { - "title": "Properties", - "children": [ - 564, - 565, - 561, - 558, - 551, - 560, - 567, - 553, - 557, - 556, - 566, - 555, - 552, - 563, - 554, - 559, - 562 - ] - } - ], - "extendedTypes": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - } - ] - }, - { - "id": 641, - "name": "AdminGetNotesParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved notes." - } - ] - }, - "children": [ - { - "id": 642, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 643, - "name": "new AdminGetNotesParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 641, - "name": "AdminGetNotesParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 645, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n50\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "50" - }, - { - "id": 646, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 644, - "name": "resource_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource ID to filter notes by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 642 - ] - }, - { - "title": "Properties", - "children": [ - 645, - 646, - 644 - ] - } - ] - }, - { - "id": 659, - "name": "AdminGetNotificationsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved notifications." - } - ] - }, - "children": [ - { - "id": 660, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 661, - "name": "new AdminGetNotificationsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 659, - "name": "AdminGetNotificationsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 666, - "name": "event_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Event name to filter notifications by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 665, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 664, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 670, - "name": "include_resends", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include resends in the results." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 662, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n50\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "50" - }, - { - "id": 663, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 668, - "name": "resource_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource ID to filter notifications by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 667, - "name": "resource_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Resource type to filter notifications by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 669, - "name": "to", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter notifications by their " - }, - { - "kind": "code", - "text": "`to`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 660 - ] - }, - { - "title": "Properties", - "children": [ - 666, - 665, - 664, - 670, - 662, - 663, - 668, - 667, - 669 - ] - } - ] - }, - { - "id": 906, - "name": "AdminGetOrdersOrderParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 907, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 908, - "name": "new AdminGetOrdersOrderParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 906, - "name": "AdminGetOrdersOrderParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 909, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 910, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 907 - ] - }, - { - "title": "Properties", - "children": [ - 909, - 910 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 911, - "name": "AdminGetOrdersParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved orders." - } - ] - }, - "children": [ - { - "id": 912, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 913, - "name": "new AdminGetOrdersParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 911, - "name": "AdminGetOrdersParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4478, - "name": "AdminListOrdersSelector.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4477, - "name": "AdminListOrdersSelector.constructor" - } - }, - { - "id": 931, - "name": "canceled_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the orders' " - }, - { - "kind": "code", - "text": "`canceled_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4492, - "name": "AdminListOrdersSelector.canceled_at" - } - }, - { - "id": 924, - "name": "cart_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Cart ID to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4485, - "name": "AdminListOrdersSelector.cart_id" - } - }, - { - "id": 932, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the orders' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4493, - "name": "AdminListOrdersSelector.created_at" - } - }, - { - "id": 928, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Currency code to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4489, - "name": "AdminListOrdersSelector.currency_code" - } - }, - { - "id": 925, - "name": "customer_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Customer ID to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4486, - "name": "AdminListOrdersSelector.customer_id" - } - }, - { - "id": 923, - "name": "display_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Display ID to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4484, - "name": "AdminListOrdersSelector.display_id" - } - }, - { - "id": 926, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Email to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4487, - "name": "AdminListOrdersSelector.email" - } - }, - { - "id": 916, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 917, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 921, - "name": "fulfillment_status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fulfillment statuses to filter orders by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4482, - "name": "AdminListOrdersSelector.fulfillment_status" - } - }, - { - "id": 919, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4480, - "name": "AdminListOrdersSelector.id" - } - }, - { - "id": 915, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n50\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "50" - }, - { - "id": 914, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 922, - "name": "payment_status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payment statuses to filter orders by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4483, - "name": "AdminListOrdersSelector.payment_status" - } - }, - { - "id": 918, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search orders' shipping address, first name, email, and display ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4479, - "name": "AdminListOrdersSelector.q" - } - }, - { - "id": 927, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Regions to filter orders by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 4488, - "name": "AdminListOrdersSelector.region_id" - } - }, - { - "id": 930, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sales channel IDs to filter orders by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4491, - "name": "AdminListOrdersSelector.sales_channel_id" - } - }, - { - "id": 920, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statuses to filter orders by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4481, - "name": "AdminListOrdersSelector.status" - } - }, - { - "id": 929, - "name": "tax_rate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tax rate to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4490, - "name": "AdminListOrdersSelector.tax_rate" - } - }, - { - "id": 933, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the orders' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4494, - "name": "AdminListOrdersSelector.updated_at" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 912 - ] - }, - { - "title": "Properties", - "children": [ - 931, - 924, - 932, - 928, - 925, - 923, - 926, - 916, - 917, - 921, - 919, - 915, - 914, - 922, - 918, - 927, - 930, - 920, - 929, - 933 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4476, - "name": "AdminListOrdersSelector", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1006, - "name": "AdminGetPaymentCollectionsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1007, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1008, - "name": "new AdminGetPaymentCollectionsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1006, - "name": "AdminGetPaymentCollectionsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 1009, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 1010, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1007 - ] - }, - { - "title": "Properties", - "children": [ - 1009, - 1010 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1129, - "name": "AdminGetPriceListPaginationParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved price lists." - } - ] - }, - "children": [ - { - "id": 1130, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1131, - "name": "new AdminGetPriceListPaginationParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1129, - "name": "AdminGetPriceListPaginationParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4069, - "name": "FilterablePriceListProps.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4068, - "name": "FilterablePriceListProps.constructor" - } - }, - { - "id": 1143, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the price lists' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4077, - "name": "FilterablePriceListProps.created_at" - } - }, - { - "id": 1140, - "name": "customer_groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter price lists by their associated customer groups." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4074, - "name": "FilterablePriceListProps.customer_groups" - } - }, - { - "id": 1145, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the price lists' " - }, - { - "kind": "code", - "text": "`deleted_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4079, - "name": "FilterablePriceListProps.deleted_at" - } - }, - { - "id": 1141, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description to filter price lists by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4075, - "name": "FilterablePriceListProps.description" - } - }, - { - "id": 1134, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1136, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter price lists by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4070, - "name": "FilterablePriceListProps.id" - } - }, - { - "id": 1133, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n10\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "10" - }, - { - "id": 1139, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name to filter price lists by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4073, - "name": "FilterablePriceListProps.name" - } - }, - { - "id": 1132, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 1135, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1137, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search terms to search price lists' description, name, and customer group's name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4071, - "name": "FilterablePriceListProps.q" - } - }, - { - "id": 1138, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statuses to filter price lists by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4064, - "name": "PriceListStatus", - "package": "@medusajs/medusa" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4072, - "name": "FilterablePriceListProps.status" - } - }, - { - "id": 1142, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Types to filter price lists by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4061, - "name": "PriceListType", - "package": "@medusajs/medusa" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4076, - "name": "FilterablePriceListProps.type" - } - }, - { - "id": 1144, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the price lists' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4078, - "name": "FilterablePriceListProps.updated_at" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1130 - ] - }, - { - "title": "Properties", - "children": [ - 1143, - 1140, - 1145, - 1141, - 1134, - 1136, - 1133, - 1139, - 1132, - 1135, - 1137, - 1138, - 1142, - 1144 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4067, - "name": "FilterablePriceListProps", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1107, - "name": "AdminGetPriceListsPriceListProductsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved products associated with a price list." - } - ] - }, - "children": [ - { - "id": 1108, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1109, - "name": "new AdminGetPriceListsPriceListProductsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 1110, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "target": 1107, - "name": "AdminGetPriceListsPriceListProductsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin(\n { limit: 50 }\n).constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin(\n { limit: 50 }\n).constructor" - } - }, - { - "id": 1114, - "name": "collection_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated collection ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1122, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the products' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 1124, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the products' " - }, - { - "kind": "code", - "text": "`deleted_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 1117, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1125, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin(\n { limit: 50 }\n).expand" - } - }, - { - "id": 1126, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin(\n { limit: 50 }\n).fields" - } - }, - { - "id": 1118, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Handle to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1111, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1119, - "name": "is_giftcard", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by whether they're gift cards." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1128, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of products returned in the list. Default is " - }, - { - "kind": "code", - "text": "`50`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin(\n { limit: 50 }\n).limit" - } - }, - { - "id": 1127, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin(\n { limit: 50 }\n).offset" - } - }, - { - "id": 1121, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1112, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search products' title, description, product variant's title and sku, and product collection's title." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1113, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statuses to filter products by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product.ts", - "qualifiedName": "ProductStatus" - }, - "name": "ProductStatus", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1115, - "name": "tags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tags to filter products by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1116, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Title to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1120, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Type to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1123, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the products' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1108 - ] - }, - { - "title": "Properties", - "children": [ - 1114, - 1122, - 1124, - 1117, - 1125, - 1126, - 1118, - 1111, - 1119, - 1128, - 1127, - 1121, - 1112, - 1113, - 1115, - 1116, - 1120, - 1123 - ] - } - ], - "extendedTypes": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - } - ] - }, - { - "id": 1173, - "name": "AdminGetProductCategoriesParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved product categories." - } - ] - }, - "children": [ - { - "id": 1174, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1175, - "name": "new AdminGetProductCategoriesParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 1176, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "target": 1173, - "name": "AdminGetProductCategoriesParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).constructor" - } - }, - { - "id": 1183, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).expand" - } - }, - { - "id": 1184, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).fields" - } - }, - { - "id": 1178, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Handle to filter product categories by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1179, - "name": "include_descendants_tree", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include child product categories in the response." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1181, - "name": "is_active", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter product categories by whether they're active." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1180, - "name": "is_internal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter product categories by whether they're internal." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1186, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of product categories returned in the list. The default is " - }, - { - "kind": "code", - "text": "`100`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).limit" - } - }, - { - "id": 1185, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).offset" - } - }, - { - "id": 1182, - "name": "parent_category_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter product categories by their associated parent ID." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1177, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search product categories' names and handles." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1174 - ] - }, - { - "title": "Properties", - "children": [ - 1183, - 1184, - 1178, - 1179, - 1181, - 1180, - 1186, - 1185, - 1182, - 1177 - ] - } - ], - "extendedTypes": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - } - ] - }, - { - "id": 1168, - "name": "AdminGetProductCategoryParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1169, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1170, - "name": "new AdminGetProductCategoryParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1168, - "name": "AdminGetProductCategoryParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 1171, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 1172, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1169 - ] - }, - { - "title": "Properties", - "children": [ - 1171, - 1172 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1402, - "name": "AdminGetProductParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1403, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1404, - "name": "new AdminGetProductParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1402, - "name": "AdminGetProductParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 1405, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 1406, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1403 - ] - }, - { - "title": "Properties", - "children": [ - 1405, - 1406 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1241, - "name": "AdminGetProductTagsPaginationParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how a list of data is paginated." - } - ] - }, - "children": [ - { - "id": 1242, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1243, - "name": "new AdminGetProductTagsPaginationParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1241, - "name": "AdminGetProductTagsPaginationParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1244, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n10\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "10" - }, - { - "id": 1245, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1242 - ] - }, - { - "title": "Properties", - "children": [ - 1244, - 1245 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1246, - "name": "AdminGetProductTagsParams" - } - ] - }, - { - "id": 1246, - "name": "AdminGetProductTagsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved product tags." - } - ] - }, - "children": [ - { - "id": 1247, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1248, - "name": "new AdminGetProductTagsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1246, - "name": "AdminGetProductTagsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 1243, - "name": "AdminGetProductTagsPaginationParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1242, - "name": "AdminGetProductTagsPaginationParams.constructor" - } - }, - { - "id": 1252, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the product tags' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 1255, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter product tags by their associated discount condition's ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1249, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter product tags by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 1256, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n10\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "10", - "inheritedFrom": { - "type": "reference", - "target": 1244, - "name": "AdminGetProductTagsPaginationParams.limit" - } - }, - { - "id": 1257, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": 1245, - "name": "AdminGetProductTagsPaginationParams.offset" - } - }, - { - "id": 1254, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1250, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search product tags' value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1253, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the product tags' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 1251, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Values to search product tags by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1247 - ] - }, - { - "title": "Properties", - "children": [ - 1252, - 1255, - 1249, - 1256, - 1257, - 1254, - 1250, - 1253, - 1251 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1241, - "name": "AdminGetProductTagsPaginationParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1263, - "name": "AdminGetProductTypesParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved product types." - } - ] - }, - "children": [ - { - "id": 1264, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1265, - "name": "new AdminGetProductTypesParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1263, - "name": "AdminGetProductTypesParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3970, - "name": "FindPaginationParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3969, - "name": "FindPaginationParams.constructor" - } - }, - { - "id": 1269, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the product types' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 1272, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter product types by their associated discount condition's ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1266, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter product types by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 1274, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": 3972, - "name": "FindPaginationParams.limit" - } - }, - { - "id": 1273, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": 3971, - "name": "FindPaginationParams.offset" - } - }, - { - "id": 1271, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1267, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search terms to search product types' value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1270, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the product types' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 1268, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Values to filter product types by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1264 - ] - }, - { - "title": "Properties", - "children": [ - 1269, - 1272, - 1266, - 1274, - 1273, - 1271, - 1267, - 1270, - 1268 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3968, - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1407, - "name": "AdminGetProductsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved products." - } - ] - }, - "children": [ - { - "id": 1408, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1409, - "name": "new AdminGetProductsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1407, - "name": "AdminGetProductsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4624, - "name": "FilterableProductProps.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4623, - "name": "FilterableProductProps.constructor" - } - }, - { - "id": 1428, - "name": "category_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated product category's ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4638, - "name": "FilterableProductProps.category_id" - } - }, - { - "id": 1419, - "name": "collection_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated product collection's ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4629, - "name": "FilterableProductProps.collection_id" - } - }, - { - "id": 1430, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the products' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4640, - "name": "FilterableProductProps.created_at" - } - }, - { - "id": 1432, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the products' " - }, - { - "kind": "code", - "text": "`deleted_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4642, - "name": "FilterableProductProps.deleted_at" - } - }, - { - "id": 1422, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4632, - "name": "FilterableProductProps.description" - } - }, - { - "id": 1427, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated discount condition's ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4637, - "name": "FilterableProductProps.discount_condition_id" - } - }, - { - "id": 1412, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1413, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1423, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Handle to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4633, - "name": "FilterableProductProps.handle" - } - }, - { - "id": 1415, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter products by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 4625, - "name": "FilterableProductProps.id" - } - }, - { - "id": 1429, - "name": "include_category_children", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include product category children in the response." - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "text", - "text": "product_categories" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 4639, - "name": "FilterableProductProps.include_category_children" - } - }, - { - "id": 1424, - "name": "is_giftcard", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by whether they're gift cards." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 4634, - "name": "FilterableProductProps.is_giftcard" - } - }, - { - "id": 1411, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n50\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "50" - }, - { - "id": 1410, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 1414, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1418, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated price lists' ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4628, - "name": "FilterableProductProps.price_list_id" - } - }, - { - "id": 1416, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search products' title, description, variants' title and sku, and collections' title." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4626, - "name": "FilterableProductProps.q" - } - }, - { - "id": 1426, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated sales channels' ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4636, - "name": "FilterableProductProps.sales_channel_id" - } - }, - { - "id": 1417, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statuses to filter products by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product.ts", - "qualifiedName": "ProductStatus" - }, - "name": "ProductStatus", - "package": "@medusajs/medusa" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4627, - "name": "FilterableProductProps.status" - } - }, - { - "id": 1420, - "name": "tags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated tags' value." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4630, - "name": "FilterableProductProps.tags" - } - }, - { - "id": 1421, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Title to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4631, - "name": "FilterableProductProps.title" - } - }, - { - "id": 1425, - "name": "type_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated product type's ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4635, - "name": "FilterableProductProps.type_id" - } - }, - { - "id": 1431, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the products' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4641, - "name": "FilterableProductProps.updated_at" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1408 - ] - }, - { - "title": "Properties", - "children": [ - 1428, - 1419, - 1430, - 1432, - 1422, - 1427, - 1412, - 1413, - 1423, - 1415, - 1429, - 1424, - 1411, - 1410, - 1414, - 1418, - 1416, - 1426, - 1417, - 1420, - 1421, - 1425, - 1431 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4622, - "name": "FilterableProductProps", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1433, - "name": "AdminGetProductsVariantsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1434, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1435, - "name": "new AdminGetProductsVariantsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1433, - "name": "AdminGetProductsVariantsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1437, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1436, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1439, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "100" - }, - { - "id": 1438, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1434 - ] - }, - { - "title": "Properties", - "children": [ - 1437, - 1436, - 1439, - 1438 - ] - } - ] - }, - { - "id": 1578, - "name": "AdminGetRegionsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved regions." - } - ] - }, - "children": [ - { - "id": 1579, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1580, - "name": "new AdminGetRegionsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 1581, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "target": 1578, - "name": "AdminGetRegionsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 50,\n offset: 0,\n}).constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 50,\n offset: 0,\n}).constructor" - } - }, - { - "id": 1582, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the regions' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 1584, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the regions' " - }, - { - "kind": "code", - "text": "`deleted_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 1585, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 50,\n offset: 0,\n}).expand" - } - }, - { - "id": 1586, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 50,\n offset: 0,\n}).fields" - } - }, - { - "id": 1588, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 50,\n offset: 0,\n}).limit" - } - }, - { - "id": 1587, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 50,\n offset: 0,\n}).offset" - } - }, - { - "id": 1583, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the regions' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1579 - ] - }, - { - "title": "Properties", - "children": [ - 1582, - 1584, - 1585, - 1586, - 1588, - 1587, - 1583 - ] - } - ], - "extendedTypes": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - } - ] - }, - { - "id": 1550, - "name": "AdminGetRegionsRegionFulfillmentOptionsRes", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of fulfillment options in a region." - } - ] - }, - "children": [ - { - "id": 1551, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1552, - "name": "new AdminGetRegionsRegionFulfillmentOptionsRes", + "id": 107, + "name": "new AdminDeleteProductsFromCollectionReq", "variant": "signature", "kind": 16384, "flags": {}, @@ -28061,22 +4746,22 @@ "summary": [ { "kind": "text", - "text": "The list of fulfillment options in a region." + "text": "The details of the products to remove from the collection." } ] }, "type": { "type": "reference", - "target": 1550, - "name": "AdminGetRegionsRegionFulfillmentOptionsRes", + "target": 105, + "name": "AdminDeleteProductsFromCollectionReq", "package": "@medusajs/medusa" } } ] }, { - "id": 1553, - "name": "fulfillment_options", + "id": 108, + "name": "product_ids", "variant": "declaration", "kind": 1024, "flags": {}, @@ -28084,2152 +4769,7 @@ "summary": [ { "kind": "text", - "text": "Fulfillment providers details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1545, - "name": "FulfillmentOption", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1551 - ] - }, - { - "title": "Properties", - "children": [ - 1553 - ] - } - ] - }, - { - "id": 1674, - "name": "AdminGetReservationsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved reservations." - } - ] - }, - "children": [ - { - "id": 1675, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1676, - "name": "new AdminGetReservationsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 1677, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "target": 1674, - "name": "AdminGetReservationsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" - } - }, - { - "id": 1683, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the reservations' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 1681, - "name": "created_by", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "\"Create by\" user IDs to filter reservations by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1684, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "String filters tp apply on the reservations' " - }, - { - "kind": "code", - "text": "`description`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 1685, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).expand" - } - }, - { - "id": 1686, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).fields" - } - }, - { - "id": 1679, - "name": "inventory_item_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Inventory item IDs to filter reservations by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1688, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).limit" - } - }, - { - "id": 1680, - "name": "line_item_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Line item IDs to filter reservations by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1678, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Location IDs to filter reservations by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1687, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).offset" - } - }, - { - "id": 1682, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Numerical filters to apply on the reservations' " - }, - { - "kind": "code", - "text": "`quantity`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "reference", - "target": 3928, - "name": "NumericalComparisonOperator", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1675 - ] - }, - { - "title": "Properties", - "children": [ - 1683, - 1681, - 1684, - 1685, - 1686, - 1679, - 1688, - 1680, - 1678, - 1687, - 1682 - ] - } - ], - "extendedTypes": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - } - ] - }, - { - "id": 1641, - "name": "AdminGetReturnsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how a list of data is paginated." - } - ] - }, - "children": [ - { - "id": 1642, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1643, - "name": "new AdminGetReturnsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1641, - "name": "AdminGetReturnsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1644, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n50\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "50" - }, - { - "id": 1645, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n50\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1642 - ] - }, - { - "title": "Properties", - "children": [ - 1644, - 1645 - ] - } - ] - }, - { - "id": 1718, - "name": "AdminGetSalesChannelsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved sales channels." - } - ] - }, - "children": [ - { - "id": 1719, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1720, - "name": "new AdminGetSalesChannelsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 1721, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "target": 1718, - "name": "AdminGetSalesChannelsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin().constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin().constructor" - } - }, - { - "id": 1726, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on sales channels' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 1728, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on sales channels' " - }, - { - "kind": "code", - "text": "`deleted_at`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 1725, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description to filter sales channels by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1730, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin().expand" - } - }, - { - "id": 1731, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin().fields" - } - }, - { - "id": 1722, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID to filter sales channels by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1733, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin().limit" - } - }, - { - "id": 1724, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name to filter sales channels by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1732, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin().offset" - } - }, - { - "id": 1729, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1723, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search sales channels' names and descriptions." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1727, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on sales channels' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1719 - ] - }, - { - "title": "Properties", - "children": [ - 1726, - 1728, - 1725, - 1730, - 1731, - 1722, - 1733, - 1724, - 1732, - 1729, - 1723, - 1727 - ] - } - ], - "extendedTypes": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - } - ] - }, - { - "id": 1771, - "name": "AdminGetShippingOptionsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter the retrieved shipping options." - } - ] - }, - "children": [ - { - "id": 1772, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1773, - "name": "new AdminGetShippingOptionsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1771, - "name": "AdminGetShippingOptionsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1776, - "name": "admin_only", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter shipping options by whether they're available for admin users only." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1775, - "name": "is_return", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter shipping options by whether they're return shipping options." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1774, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter shipping options by the ID of the region they belong to." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1772 - ] - }, - { - "title": "Properties", - "children": [ - 1776, - 1775, - 1774 - ] - } - ] - }, - { - "id": 1831, - "name": "AdminGetStockLocationsLocationParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1832, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1833, - "name": "new AdminGetStockLocationsLocationParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1831, - "name": "AdminGetStockLocationsLocationParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 1834, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 1835, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1832 - ] - }, - { - "title": "Properties", - "children": [ - 1834, - 1835 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1836, - "name": "AdminGetStockLocationsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved stock locations." - } - ] - }, - "children": [ - { - "id": 1837, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1838, - "name": "new AdminGetStockLocationsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 1839, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "target": 1836, - "name": "AdminGetStockLocationsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" - } - }, - { - "id": 1842, - "name": "address_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter stock locations by the ID of their associated addresses." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1844, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).expand" - } - }, - { - "id": 1845, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).fields" - } - }, - { - "id": 1840, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter stock locations by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1847, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).limit" - } - }, - { - "id": 1841, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Names to filter stock locations by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1846, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).offset" - } - }, - { - "id": 1843, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter stock locations by the ID of their associated sales channels." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1837 - ] - }, - { - "title": "Properties", - "children": [ - 1842, - 1844, - 1845, - 1840, - 1847, - 1841, - 1846, - 1843 - ] - } - ], - "extendedTypes": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - } - ] - }, - { - "id": 1891, - "name": "AdminGetSwapsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how a list of data is paginated." - } - ] - }, - "children": [ - { - "id": 1892, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1893, - "name": "new AdminGetSwapsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1891, - "name": "AdminGetSwapsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1894, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "50" - }, - { - "id": 1895, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1892 - ] - }, - { - "title": "Properties", - "children": [ - 1894, - 1895 - ] - } - ] - }, - { - "id": 1905, - "name": "AdminGetTaxRatesParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved tax rates." - } - ] - }, - "children": [ - { - "id": 1906, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1907, - "name": "new AdminGetTaxRatesParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1905, - "name": "AdminGetTaxRatesParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1910, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Code to filter tax rates by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1914, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1915, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1913, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n50\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "50" - }, - { - "id": 1909, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name to filter tax rates by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1912, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 1911, - "name": "rate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number filters to filter tax rates' " - }, - { - "kind": "code", - "text": "`rate`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "reference", - "target": 3928, - "name": "NumericalComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 1908, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter tax rates by the IDs of their associates region." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1906 - ] - }, - { - "title": "Properties", - "children": [ - 1910, - 1914, - 1915, - 1913, - 1909, - 1912, - 1911, - 1908 - ] - } - ] - }, - { - "id": 1916, - "name": "AdminGetTaxRatesTaxRateParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1917, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1918, - "name": "new AdminGetTaxRatesTaxRateParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1916, - "name": "AdminGetTaxRatesTaxRateParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1919, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1920, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." + "text": "An array of Product IDs to remove from the Product Collection." } ] }, @@ -30246,1541 +4786,13 @@ { "title": "Constructors", "children": [ - 1917 + 106 ] }, { "title": "Properties", "children": [ - 1919, - 1920 - ] - } - ] - }, - { - "id": 2089, - "name": "AdminGetVariantParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 2090, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2091, - "name": "new AdminGetVariantParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2089, - "name": "AdminGetVariantParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 2092, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 2093, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2090 - ] - }, - { - "title": "Properties", - "children": [ - 2092, - 2093 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 2074, - "name": "AdminGetVariantsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved product variants." - } - ] - }, - "children": [ - { - "id": 2075, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2076, - "name": "new AdminGetVariantsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2074, - "name": "AdminGetVariantsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4766, - "name": "AdminPriceSelectionParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4765, - "name": "AdminPriceSelectionParams.constructor" - } - }, - { - "id": 2086, - "name": "cart_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a cart ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4768, - "name": "AdminPriceSelectionParams.cart_id" - } - }, - { - "id": 2088, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a currency code." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4770, - "name": "AdminPriceSelectionParams.currency_code" - } - }, - { - "id": 2085, - "name": "customer_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a customer ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4767, - "name": "AdminPriceSelectionParams.customer_id" - } - }, - { - "id": 2080, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": 4771, - "name": "AdminPriceSelectionParams.expand" - } - }, - { - "id": 2081, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": 4772, - "name": "AdminPriceSelectionParams.fields" - } - }, - { - "id": 2082, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter product variants by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 2084, - "name": "inventory_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number filters to apply on product variants' " - }, - { - "kind": "code", - "text": "`inventory_quantity`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "reference", - "target": 3928, - "name": "NumericalComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 2078, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20" - }, - { - "id": 2079, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 2077, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search product variants' IDs." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2087, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a region ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4769, - "name": "AdminPriceSelectionParams.region_id" - } - }, - { - "id": 2083, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Titles to filter product variants by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2075 - ] - }, - { - "title": "Properties", - "children": [ - 2086, - 2088, - 2085, - 2080, - 2081, - 2082, - 2084, - 2078, - 2079, - 2077, - 2087, - 2083 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4764, - "name": "AdminPriceSelectionParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 4341, - "name": "AdminListCustomerSelector", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters used to filter retrieved customers." - } - ] - }, - "children": [ - { - "id": 4342, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4343, - "name": "new AdminListCustomerSelector", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4341, - "name": "AdminListCustomerSelector", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4346, - "name": "groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter customers by the customer's customer groups." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4345, - "name": "has_account", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter customers by whether they have an account." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4344, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term used to search customers' email, first name, last name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4342 - ] - }, - { - "title": "Properties", - "children": [ - 4346, - 4345, - 4344 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 193, - "name": "AdminGetCustomersParams" - } - ] - }, - { - "id": 4476, - "name": "AdminListOrdersSelector", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on the retrieved orders." - } - ] - }, - "children": [ - { - "id": 4477, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4478, - "name": "new AdminListOrdersSelector", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4476, - "name": "AdminListOrdersSelector", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4492, - "name": "canceled_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the orders' " - }, - { - "kind": "code", - "text": "`canceled_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 4485, - "name": "cart_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Cart ID to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4493, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the orders' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 4489, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Currency code to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4486, - "name": "customer_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Customer ID to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4484, - "name": "display_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Display ID to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4487, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Email to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4482, - "name": "fulfillment_status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fulfillment statuses to filter orders by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4480, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4483, - "name": "payment_status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payment statuses to filter orders by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4479, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search orders' shipping address, first name, email, and display ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4488, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Regions to filter orders by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 4491, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sales channel IDs to filter orders by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4481, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statuses to filter orders by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4490, - "name": "tax_rate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tax rate to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4494, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the orders' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4477 - ] - }, - { - "title": "Properties", - "children": [ - 4492, - 4485, - 4493, - 4489, - 4486, - 4484, - 4487, - 4482, - 4480, - 4483, - 4479, - 4488, - 4491, - 4481, - 4490, - 4494 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 911, - "name": "AdminGetOrdersParams" - } - ] - }, - { - "id": 10, - "name": "AdminPostAnalyticsConfigAnalyticsConfigReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 11, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 12, - "name": "new AdminPostAnalyticsConfigAnalyticsConfigReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 10, - "name": "AdminPostAnalyticsConfigAnalyticsConfigReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 14, - "name": "anonymize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 13, - "name": "opt_out", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 11 - ] - }, - { - "title": "Properties", - "children": [ - 14, - 13 - ] - } - ] - }, - { - "id": 5, - "name": "AdminPostAnalyticsConfigReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 6, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 7, - "name": "new AdminPostAnalyticsConfigReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 5, - "name": "AdminPostAnalyticsConfigReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 9, - "name": "anonymize", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 8, - "name": "opt_out", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 6 - ] - }, - { - "title": "Properties", - "children": [ - 9, - 8 - ] - } - ] - }, - { - "id": 21, - "name": "AdminPostAuthReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The admin's credentials used to log in." - } - ] - }, - "children": [ - { - "id": 22, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 23, - "name": "new AdminPostAuthReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The admin's credentials used to log in." - } - ] - }, - "type": { - "type": "reference", - "target": 21, - "name": "AdminPostAuthReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 24, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's email." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 25, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's password." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 22 - ] - }, - { - "title": "Properties", - "children": [ - 24, - 25 - ] - } - ] - }, - { - "id": 33, - "name": "AdminPostBatchesReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the batch job to create." - } - ] - }, - "children": [ - { - "id": 34, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 35, - "name": "new AdminPostBatchesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the batch job to create." - } - ] - }, - "type": { - "type": "reference", - "target": 33, - "name": "AdminPostBatchesReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 37, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional infomration regarding the batch to be used for processing." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 38, - "name": "dry_run", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Set a batch job in dry_run mode, which would delay executing the batch job until it's confirmed." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 36, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of batch job to start, which is defined by the `batchType` property of the associated batch job strategy." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 34 - ] - }, - { - "title": "Properties", - "children": [ - 37, - 38, - 36 + 108 ] } ] @@ -31830,6 +4842,27 @@ } ] }, + { + "id": 112, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the collection." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, { "id": 113, "name": "handle", @@ -31886,27 +4919,6 @@ "name": "Record", "package": "typescript" } - }, - { - "id": 112, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the collection." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ @@ -31919,16 +4931,154 @@ { "title": "Properties", "children": [ + 112, 113, - 114, - 112 + 114 ] } ] }, { - "id": 82, - "name": "AdminPostCollectionsReq", + "id": 115, + "name": "AdminCurrenciesListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of currencies with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 116, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 117, + "name": "currencies", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of currency details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/currency.ts", + "qualifiedName": "Currency" + }, + "name": "Currency", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 117 + ] + } + ] + } + } + ] + } + }, + { + "id": 118, + "name": "AdminCurrenciesRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A currency's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 119, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 120, + "name": "currency", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Currency details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/currency.ts", + "qualifiedName": "Currency" + }, + "name": "Currency", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 120 + ] + } + ] + } + } + }, + { + "id": 121, + "name": "AdminGetCurrenciesParams", "variant": "declaration", "kind": 128, "flags": {}, @@ -31936,44 +5086,46 @@ "summary": [ { "kind": "text", - "text": "The product collection's details." + "text": "Parameters used to filter and configure the pagination of the retrieved currencies." } ] }, "children": [ { - "id": 83, + "id": 122, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 84, - "name": "new AdminPostCollectionsReq", + "id": 123, + "name": "new AdminGetCurrenciesParams", "variant": "signature", "kind": 16384, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product collection's details." - } - ] - }, "type": { "type": "reference", - "target": 82, - "name": "AdminPostCollectionsReq", + "target": 121, + "name": "AdminGetCurrenciesParams", "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3977, + "name": "FindPaginationParams.constructor" } } - ] + ], + "inheritedFrom": { + "type": "reference", + "target": 3976, + "name": "FindPaginationParams.constructor" + } }, { - "id": 86, - "name": "handle", + "id": 124, + "name": "code", "variant": "declaration", "kind": 1024, "flags": { @@ -31983,7 +5135,7 @@ "summary": [ { "kind": "text", - "text": "An optional handle to be used in slugs. If none is provided, the kebab-case version of the title will be used." + "text": "Code to filter currencies by." } ] }, @@ -31993,8 +5145,8 @@ } }, { - "id": 87, - "name": "metadata", + "id": 125, + "name": "includes_tax", "variant": "declaration", "kind": 1024, "flags": { @@ -32004,41 +5156,55 @@ "summary": [ { "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" + "text": "Filter currencies by whether they include tax." } ], - "name": "Record", - "package": "typescript" + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "text", + "text": "tax_inclusive_pricing" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" } }, { - "id": 85, - "name": "title", + "id": 126, + "name": "order", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { "kind": "text", - "text": "The title of the collection." + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": ".\nBy default, the returned currencies will be sorted by their " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " field." } ] }, @@ -32046,23 +5212,109 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 127, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": 3978, + "name": "FindPaginationParams.offset" + } + }, + { + "id": 128, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": 3979, + "name": "FindPaginationParams.limit" + } } ], "groups": [ { "title": "Constructors", "children": [ - 83 + 122 ] }, { "title": "Properties", "children": [ - 86, - 87, - 85 + 124, + 125, + 126, + 127, + 128 ] } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3975, + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } ] }, { @@ -32232,7 +5484,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 4328, + "target": 4335, "name": "CustomerGroupsBatchCustomer", "package": "@medusajs/medusa" } @@ -32254,125 +5506,6 @@ } ] }, - { - "id": 172, - "name": "AdminPostCustomerGroupsGroupReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update in the customer group." - } - ] - }, - "children": [ - { - "id": 173, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 174, - "name": "new AdminPostCustomerGroupsGroupReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update in the customer group." - } - ] - }, - "type": { - "type": "reference", - "target": 172, - "name": "AdminPostCustomerGroupsGroupReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 176, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Metadata of the customer group." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 175, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the customer group" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 173 - ] - }, - { - "title": "Properties", - "children": [ - 176, - 175 - ] - } - ] - }, { "id": 145, "name": "AdminPostCustomerGroupsReq", @@ -32418,6 +5551,25 @@ } ] }, + { + "id": 148, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the customer group" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, { "id": 149, "name": "metadata", @@ -32453,25 +5605,6 @@ "name": "Record", "package": "typescript" } - }, - { - "id": 148, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the customer group" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ @@ -32484,15 +5617,15 @@ { "title": "Properties", "children": [ - 149, - 148 + 148, + 149 ] } ] }, { - "id": 202, - "name": "AdminPostCustomersCustomerReq", + "id": 150, + "name": "AdminDeleteCustomerGroupsGroupCustomerBatchReq", "variant": "declaration", "kind": 128, "flags": {}, @@ -32500,21 +5633,21 @@ "summary": [ { "kind": "text", - "text": "The details of the customer to update." + "text": "The customers to remove from the customer group." } ] }, "children": [ { - "id": 203, + "id": 151, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 204, - "name": "new AdminPostCustomersCustomerReq", + "id": 152, + "name": "new AdminDeleteCustomerGroupsGroupCustomerBatchReq", "variant": "signature", "kind": 16384, "flags": {}, @@ -32522,74 +5655,30 @@ "summary": [ { "kind": "text", - "text": "The details of the customer to update." + "text": "The customers to remove from the customer group." } ] }, "type": { "type": "reference", - "target": 202, - "name": "AdminPostCustomersCustomerReq", + "target": 150, + "name": "AdminDeleteCustomerGroupsGroupCustomerBatchReq", "package": "@medusajs/medusa" } } ] }, { - "id": 205, - "name": "email", + "id": 153, + "name": "customer_ids", "variant": "declaration", "kind": 1024, - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The Customer's email. You can't update the email of a registered customer." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 206, - "name": "first_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Customer's first name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 211, - "name": "groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of customer groups to which the customer belongs." + "text": "The ids of the customers to remove" } ] }, @@ -32597,15 +5686,78 @@ "type": "array", "elementType": { "type": "reference", - "target": 4347, - "name": "Group", + "target": 4335, + "name": "CustomerGroupsBatchCustomer", "package": "@medusajs/medusa" } } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 151 + ] }, { - "id": 207, - "name": "last_name", + "title": "Properties", + "children": [ + 153 + ] + } + ] + }, + { + "id": 154, + "name": "AdminGetCustomerGroupsGroupParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 155, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 156, + "name": "new AdminGetCustomerGroupsGroupParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 154, + "name": "AdminGetCustomerGroupsGroupParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 157, + "name": "expand", "variant": "declaration", "kind": 1024, "flags": { @@ -32615,7 +5767,308 @@ "summary": [ { "kind": "text", - "text": "The Customer's last name." + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 158, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 155 + ] + }, + { + "title": "Properties", + "children": [ + 157, + 158 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 133, + "name": "AdminCustomerGroupsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer group's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 134, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 135, + "name": "customer_group", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Customer group details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer-group.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 135 + ] + } + ] + } + } + }, + { + "id": 136, + "name": "AdminCustomerGroupsDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 137, + "name": "AdminCustomerGroupsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 138, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 139, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of customer group details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer-group.ts", + "qualifiedName": "CustomerGroup" + }, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 139 + ] + } + ] + } + } + ] + } + }, + { + "id": 140, + "name": "defaultAdminCustomerGroupsRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "never" + } + }, + "defaultValue": "[]" + }, + { + "id": 159, + "name": "AdminGetCustomerGroupsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved customer groups." + } + ] + }, + "children": [ + { + "id": 160, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 161, + "name": "new AdminGetCustomerGroupsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 159, + "name": "AdminGetCustomerGroupsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4341, + "name": "FilterableCustomerGroupProps.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4340, + "name": "FilterableCustomerGroupProps.constructor" + } + }, + { + "id": 162, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": "." } ] }, @@ -32625,7 +6078,368 @@ } }, { - "id": 210, + "id": 163, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 164, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "10" + }, + { + "id": 165, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 166, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter customer groups by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 4342, + "name": "FilterableCustomerGroupProps.id" + } + }, + { + "id": 167, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search customer groups by their name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4343, + "name": "FilterableCustomerGroupProps.q" + } + }, + { + "id": 168, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Names to filter customer groups by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4344, + "name": "FilterableCustomerGroupProps.name" + } + }, + { + "id": 169, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the customer groups' " + }, + { + "kind": "code", + "text": "`update_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4345, + "name": "FilterableCustomerGroupProps.updated_at" + } + }, + { + "id": 170, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the customer groups' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4346, + "name": "FilterableCustomerGroupProps.created_at" + } + }, + { + "id": 171, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter customer groups by their associated discount condition's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4347, + "name": "FilterableCustomerGroupProps.discount_condition_id" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 160 + ] + }, + { + "title": "Properties", + "children": [ + 162, + 163, + 164, + 165, + 166, + 167, + 168, + 169, + 170, + 171 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4339, + "name": "FilterableCustomerGroupProps", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 172, + "name": "AdminPostCustomerGroupsGroupReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update in the customer group." + } + ] + }, + "children": [ + { + "id": 173, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 174, + "name": "new AdminPostCustomerGroupsGroupReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update in the customer group." + } + ] + }, + "type": { + "type": "reference", + "target": 172, + "name": "AdminPostCustomerGroupsGroupReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 175, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the customer group" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 176, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -32636,7 +6450,7 @@ "summary": [ { "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." + "text": "Metadata of the customer group." } ] }, @@ -32659,67 +6473,20 @@ "name": "Record", "package": "typescript" } - }, - { - "id": 208, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Customer's password." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 209, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Customer's phone number." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ { "title": "Constructors", "children": [ - 203 + 173 ] }, { "title": "Properties", "children": [ - 205, - 206, - 211, - 207, - 210, - 208, - 209 + 175, + 176 ] } ] @@ -32826,42 +6593,6 @@ "name": "string" } }, - { - "id": 192, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, { "id": 190, "name": "password", @@ -32901,6 +6632,42 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 192, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } } ], "groups": [ @@ -32916,545 +6683,171 @@ 187, 188, 189, - 192, 190, - 191 + 191, + 192 ] } ] }, { - "id": 229, - "name": "AdminPostDiscountsDiscountConditions", + "id": 177, + "name": "AdminCustomersRes", "variant": "declaration", - "kind": 128, + "kind": 2097152, "flags": {}, - "children": [ - { - "id": 230, - "name": "constructor", + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 178, + "name": "__type", "variant": "declaration", - "kind": 512, + "kind": 65536, "flags": {}, - "signatures": [ + "children": [ { - "id": 231, - "name": "new AdminPostDiscountsDiscountConditions", - "variant": "signature", - "kind": 16384, + "id": 179, + "name": "customer", + "variant": "declaration", + "kind": 1024, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Customer details." + } + ] + }, "type": { "type": "reference", - "target": 229, - "name": "AdminPostDiscountsDiscountConditions", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4353, - "name": "AdminUpsertConditionsReq.constructor" } } ], - "inheritedFrom": { - "type": "reference", - "target": 4352, - "name": "AdminUpsertConditionsReq.constructor" - } - }, - { - "id": 237, - "name": "customer_groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer groups associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`customer_groups`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" + "groups": [ + { + "title": "Properties", + "children": [ + 179 + ] } - }, - "inheritedFrom": { - "type": "reference", - "target": 4358, - "name": "AdminUpsertConditionsReq.customer_groups" + ] + } + } + }, + { + "id": 180, + "name": "AdminCustomersListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of customers with pagination fields." } - }, - { - "id": 232, - "name": "operator", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources." - } - ] - }, - "type": { + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/discount-condition.ts", - "qualifiedName": "DiscountConditionOperator" - }, - "name": "DiscountConditionOperator", + "target": 3907, + "name": "PaginatedResponse", "package": "@medusajs/medusa" - } - }, - { - "id": 234, - "name": "product_collections", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product collections associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_collections`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4355, - "name": "AdminUpsertConditionsReq.product_collections" - } - }, - { - "id": 236, - "name": "product_tags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product tags associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_tags`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4357, - "name": "AdminUpsertConditionsReq.product_tags" - } - }, - { - "id": 235, - "name": "product_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product types associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_types`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4356, - "name": "AdminUpsertConditionsReq.product_types" - } - }, - { - "id": 233, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The products associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`products`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4354, - "name": "AdminUpsertConditionsReq.products" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 230 - ] - }, - { - "title": "Properties", - "children": [ - 237, - 232, - 234, - 236, - 235, - 233 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4351, - "name": "AdminUpsertConditionsReq", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 316, - "name": "AdminPostDiscountsDiscountConditionsCondition", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 317, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 318, - "name": "new AdminPostDiscountsDiscountConditionsCondition", - "variant": "signature", - "kind": 16384, + { + "type": "reflection", + "declaration": { + "id": 181, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "type": { - "type": "reference", - "target": 316, - "name": "AdminPostDiscountsDiscountConditionsCondition", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4353, - "name": "AdminUpsertConditionsReq.constructor" - } + "children": [ + { + "id": 182, + "name": "customers", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of customer details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 182 + ] + } + ] } - ], - "inheritedFrom": { - "type": "reference", - "target": 4352, - "name": "AdminUpsertConditionsReq.constructor" } - }, - { - "id": 323, - "name": "customer_groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer groups associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`customer_groups`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4358, - "name": "AdminUpsertConditionsReq.customer_groups" - } - }, - { - "id": 320, - "name": "product_collections", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product collections associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_collections`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4355, - "name": "AdminUpsertConditionsReq.product_collections" - } - }, - { - "id": 322, - "name": "product_tags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product tags associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_tags`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4357, - "name": "AdminUpsertConditionsReq.product_tags" - } - }, - { - "id": 321, - "name": "product_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product types associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_types`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4356, - "name": "AdminUpsertConditionsReq.product_types" - } - }, - { - "id": 319, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The products associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`products`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4354, - "name": "AdminUpsertConditionsReq.products" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 317 - ] - }, - { - "title": "Properties", - "children": [ - 323, - 320, - 322, - 321, - 319 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4351, - "name": "AdminUpsertConditionsReq", - "package": "@medusajs/medusa" - } - ] + ] + } }, { - "id": 370, - "name": "AdminPostDiscountsDiscountConditionsConditionBatchParams", + "id": 183, + "name": "defaultAdminCustomersRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 193, + "name": "AdminGetCustomersParams", "variant": "declaration", "kind": 128, "flags": {}, @@ -33462,45 +6855,107 @@ "summary": [ { "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." + "text": "Parameters used to filter and configure the pagination of the retrieved customers." } ] }, "children": [ { - "id": 371, + "id": 194, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 372, - "name": "new AdminPostDiscountsDiscountConditionsConditionBatchParams", + "id": 195, + "name": "new AdminGetCustomersParams", "variant": "signature", "kind": 16384, "flags": {}, "type": { "type": "reference", - "target": 370, - "name": "AdminPostDiscountsDiscountConditionsConditionBatchParams", + "target": 193, + "name": "AdminGetCustomersParams", "package": "@medusajs/medusa" }, "inheritedFrom": { "type": "reference", - "target": 3965, - "name": "FindParams.constructor" + "target": 4350, + "name": "AdminListCustomerSelector.constructor" } } ], "inheritedFrom": { "type": "reference", - "target": 3964, - "name": "FindParams.constructor" + "target": 4349, + "name": "AdminListCustomerSelector.constructor" } }, { - "id": 373, + "id": 196, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n50\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "50" + }, + { + "id": 197, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 198, "name": "expand", "variant": "declaration", "kind": 1024, @@ -33518,16 +6973,11 @@ "type": { "type": "intrinsic", "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" } }, { - "id": 374, - "name": "fields", + "id": 199, + "name": "q", "variant": "declaration", "kind": 1024, "flags": { @@ -33537,7 +6987,7 @@ "summary": [ { "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." + "text": "Search term used to search customers' email, first name, last name." } ] }, @@ -33547,8 +6997,63 @@ }, "inheritedFrom": { "type": "reference", - "target": 3967, - "name": "FindParams.fields" + "target": 4351, + "name": "AdminListCustomerSelector.q" + } + }, + { + "id": 200, + "name": "has_account", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter customers by whether they have an account." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 4352, + "name": "AdminListCustomerSelector.has_account" + } + }, + { + "id": 201, + "name": "groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter customers by the customer's customer groups." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4353, + "name": "AdminListCustomerSelector.groups" } } ], @@ -33556,26 +7061,328 @@ { "title": "Constructors", "children": [ - 371 + 194 ] }, { "title": "Properties", "children": [ - 373, - 374 + 196, + 197, + 198, + 199, + 200, + 201 ] } ], "extendedTypes": [ { "type": "reference", - "target": 3963, - "name": "FindParams", + "target": 4348, + "name": "AdminListCustomerSelector", "package": "@medusajs/medusa" } ] }, + { + "id": 4354, + "name": "Group", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4355, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4356, + "name": "new Group", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4354, + "name": "Group", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4357, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a customer group" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4355 + ] + }, + { + "title": "Properties", + "children": [ + 4357 + ] + } + ] + }, + { + "id": 202, + "name": "AdminPostCustomersCustomerReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the customer to update." + } + ] + }, + "children": [ + { + "id": 203, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 204, + "name": "new AdminPostCustomersCustomerReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the customer to update." + } + ] + }, + "type": { + "type": "reference", + "target": 202, + "name": "AdminPostCustomersCustomerReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 205, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Customer's email. You can't update the email of a registered customer." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 206, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Customer's first name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 207, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Customer's last name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 208, + "name": "password", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Customer's password." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 209, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Customer's phone number." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 210, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 211, + "name": "groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of customer groups to which the customer belongs." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4354, + "name": "Group", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 203 + ] + }, + { + "title": "Properties", + "children": [ + 205, + 206, + 207, + 208, + 209, + 210, + 211 + ] + } + ] + }, { "id": 364, "name": "AdminPostDiscountsDiscountConditionsConditionBatchReq", @@ -33695,8 +7502,8 @@ ] }, { - "id": 324, - "name": "AdminPostDiscountsDiscountConditionsConditionParams", + "id": 370, + "name": "AdminPostDiscountsDiscountConditionsConditionBatchParams", "variant": "declaration", "kind": 128, "flags": {}, @@ -33710,39 +7517,39 @@ }, "children": [ { - "id": 325, + "id": 371, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 326, - "name": "new AdminPostDiscountsDiscountConditionsConditionParams", + "id": 372, + "name": "new AdminPostDiscountsDiscountConditionsConditionBatchParams", "variant": "signature", "kind": 16384, "flags": {}, "type": { "type": "reference", - "target": 324, - "name": "AdminPostDiscountsDiscountConditionsConditionParams", + "target": 370, + "name": "AdminPostDiscountsDiscountConditionsConditionBatchParams", "package": "@medusajs/medusa" }, "inheritedFrom": { "type": "reference", - "target": 3965, + "target": 3972, "name": "FindParams.constructor" } } ], "inheritedFrom": { "type": "reference", - "target": 3964, + "target": 3971, "name": "FindParams.constructor" } }, { - "id": 327, + "id": 373, "name": "expand", "variant": "declaration", "kind": 1024, @@ -33763,12 +7570,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 3966, + "target": 3973, "name": "FindParams.expand" } }, { - "id": 328, + "id": 374, "name": "fields", "variant": "declaration", "kind": 1024, @@ -33789,7 +7596,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 3967, + "target": 3974, "name": "FindParams.fields" } } @@ -33798,26 +7605,303 @@ { "title": "Constructors", "children": [ - 325 + 371 ] }, { "title": "Properties", "children": [ - 327, - 328 + 373, + 374 ] } ], "extendedTypes": [ { "type": "reference", - "target": 3963, + "target": 3970, "name": "FindParams", "package": "@medusajs/medusa" } ] }, + { + "id": 229, + "name": "AdminPostDiscountsDiscountConditions", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 230, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 231, + "name": "new AdminPostDiscountsDiscountConditions", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 229, + "name": "AdminPostDiscountsDiscountConditions", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4360, + "name": "AdminUpsertConditionsReq.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4359, + "name": "AdminUpsertConditionsReq.constructor" + } + }, + { + "id": 232, + "name": "operator", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/discount-condition.ts", + "qualifiedName": "DiscountConditionOperator" + }, + "name": "DiscountConditionOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 233, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The products associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4361, + "name": "AdminUpsertConditionsReq.products" + } + }, + { + "id": 234, + "name": "product_collections", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collections associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_collections`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4362, + "name": "AdminUpsertConditionsReq.product_collections" + } + }, + { + "id": 235, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product types associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_types`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4363, + "name": "AdminUpsertConditionsReq.product_types" + } + }, + { + "id": 236, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product tags associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_tags`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4364, + "name": "AdminUpsertConditionsReq.product_tags" + } + }, + { + "id": 237, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer groups associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`customer_groups`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4365, + "name": "AdminUpsertConditionsReq.customer_groups" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 230 + ] + }, + { + "title": "Properties", + "children": [ + 232, + 233, + 234, + 235, + 236, + 237 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4358, + "name": "AdminUpsertConditionsReq", + "package": "@medusajs/medusa" + } + ] + }, { "id": 238, "name": "AdminPostDiscountsDiscountConditionsParams", @@ -33854,14 +7938,14 @@ }, "inheritedFrom": { "type": "reference", - "target": 3965, + "target": 3972, "name": "FindParams.constructor" } } ], "inheritedFrom": { "type": "reference", - "target": 3964, + "target": 3971, "name": "FindParams.constructor" } }, @@ -33887,7 +7971,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 3966, + "target": 3973, "name": "FindParams.expand" } }, @@ -33913,7 +7997,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 3967, + "target": 3974, "name": "FindParams.fields" } } @@ -33936,879 +8020,7 @@ "extendedTypes": [ { "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 278, - "name": "AdminPostDiscountsDiscountDynamicCodesReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the dynamic discount to create." - } - ] - }, - "children": [ - { - "id": 279, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 280, - "name": "new AdminPostDiscountsDiscountDynamicCodesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the dynamic discount to create." - } - ] - }, - "type": { - "type": "reference", - "target": 278, - "name": "AdminPostDiscountsDiscountDynamicCodesReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 281, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique code that will be used to redeem the Discount" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 283, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 282, - "name": "usage_limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of times the discount code can be used" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "1" - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 279 - ] - }, - { - "title": "Properties", - "children": [ - 281, - 283, - 282 - ] - } - ] - }, - { - "id": 359, - "name": "AdminPostDiscountsDiscountParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 360, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 361, - "name": "new AdminPostDiscountsDiscountParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 359, - "name": "AdminPostDiscountsDiscountParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 362, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 363, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 360 - ] - }, - { - "title": "Properties", - "children": [ - 362, - 363 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 329, - "name": "AdminPostDiscountsDiscountReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the discount to update." - } - ] - }, - "children": [ - { - "id": 330, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 331, - "name": "new AdminPostDiscountsDiscountReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the discount to update." - } - ] - }, - "type": { - "type": "reference", - "target": 329, - "name": "AdminPostDiscountsDiscountReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 332, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique code that will be used to redeem the discount" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 336, - "name": "ends_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date and time at which the discount should no longer be available." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 334, - "name": "is_disabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the discount code is disabled on creation. If set to `true`, it will not be available for customers." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 340, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object containing metadata of the discount" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 339, - "name": "regions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of region IDs representing the Regions in which the Discount can be used." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 333, - "name": "rule", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The discount rule that defines how discounts are calculated" - } - ] - }, - "type": { - "type": "reference", - "target": 341, - "name": "AdminUpdateDiscountRule", - "package": "@medusajs/medusa" - } - }, - { - "id": 335, - "name": "starts_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date and time at which the discount should be available." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 338, - "name": "usage_limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of times the discount can be used" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 337, - "name": "valid_duration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The duration the discount runs between" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 330 - ] - }, - { - "title": "Properties", - "children": [ - 332, - 336, - 334, - 340, - 339, - 333, - 335, - 338, - 337 - ] - } - ] - }, - { - "id": 256, - "name": "AdminPostDiscountsDiscountRule", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Details of the discount rule to create." - } - ] - }, - "children": [ - { - "id": 257, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 258, - "name": "new AdminPostDiscountsDiscountRule", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 256, - "name": "AdminPostDiscountsDiscountRule", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 262, - "name": "allocation", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The discount rule's allocation." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/discount-rule.ts", - "qualifiedName": "AllocationType" - }, - "name": "AllocationType", - "package": "@medusajs/medusa" - } - }, - { - "id": 263, - "name": "conditions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The discount rule's conditions." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 264, - "name": "AdminCreateCondition", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 259, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The discount rule's description." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 260, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The discount rule's type." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/discount-rule.ts", - "qualifiedName": "DiscountRuleType" - }, - "name": "DiscountRuleType", - "package": "@medusajs/medusa" - } - }, - { - "id": 261, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The discount rule's value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 257 - ] - }, - { - "title": "Properties", - "children": [ - 262, - 263, - 259, - 260, - 261 - ] - } - ] - }, - { - "id": 273, - "name": "AdminPostDiscountsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 274, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 275, - "name": "new AdminPostDiscountsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 273, - "name": "AdminPostDiscountsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 276, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 277, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 274 - ] - }, - { - "title": "Properties", - "children": [ - 276, - 277 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, + "target": 3970, "name": "FindParams", "package": "@medusajs/medusa" } @@ -34878,6 +8090,93 @@ "name": "string" } }, + { + "id": 247, + "name": "rule", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount rule that defines how discounts are calculated" + } + ] + }, + "type": { + "type": "reference", + "target": 256, + "name": "AdminPostDiscountsDiscountRule", + "package": "@medusajs/medusa" + } + }, + { + "id": 248, + "name": "is_dynamic", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the discount should have multiple instances of itself, each with a different code. This can be useful for automatically generated discount codes that all have to follow a common set of rules." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 249, + "name": "is_disabled", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the discount code is disabled on creation. If set to `true`, it will not be available for customers." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 250, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date and time at which the discount should be available." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, { "id": 251, "name": "ends_at", @@ -34905,28 +8204,50 @@ } }, { - "id": 249, - "name": "is_disabled", + "id": 252, + "name": "valid_duration", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { "kind": "text", - "text": "Whether the discount code is disabled on creation. If set to `true`, it will not be available for customers." + "text": "The duration the discount runs between" } ] }, "type": { "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" + "name": "string" + } }, { - "id": 248, - "name": "is_dynamic", + "id": 253, + "name": "usage_limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of times the discount can be used" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 254, + "name": "regions", "variant": "declaration", "kind": 1024, "flags": {}, @@ -34934,15 +8255,17 @@ "summary": [ { "kind": "text", - "text": "Whether the discount should have multiple instances of itself, each with a different code. This can be useful for automatically generated discount codes that all have to follow a common set of rules." + "text": "A list of region IDs representing the Regions in which the Discount can be used." } ] }, "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } }, { "id": 255, @@ -34979,117 +8302,6 @@ "name": "Record", "package": "typescript" } - }, - { - "id": 254, - "name": "regions", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of region IDs representing the Regions in which the Discount can be used." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 247, - "name": "rule", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The discount rule that defines how discounts are calculated" - } - ] - }, - "type": { - "type": "reference", - "target": 256, - "name": "AdminPostDiscountsDiscountRule", - "package": "@medusajs/medusa" - } - }, - { - "id": 250, - "name": "starts_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date and time at which the discount should be available." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 253, - "name": "usage_limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Maximum number of times the discount can be used" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 252, - "name": "valid_duration", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The duration the discount runs between" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ @@ -35103,22 +8315,22 @@ "title": "Properties", "children": [ 246, - 251, - 249, - 248, - 255, - 254, 247, + 248, + 249, 250, + 251, + 252, 253, - 252 + 254, + 255 ] } ] }, { - "id": 446, - "name": "AdminPostDraftOrdersDraftOrderLineItemsItemReq", + "id": 256, + "name": "AdminPostDiscountsDiscountRule", "variant": "declaration", "kind": 128, "flags": {}, @@ -35126,19968 +8338,35 @@ "summary": [ { "kind": "text", - "text": "The details to update of the line item." + "text": "Details of the discount rule to create." } ] }, "children": [ { - "id": 447, + "id": 257, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 448, - "name": "new AdminPostDraftOrdersDraftOrderLineItemsItemReq", + "id": 258, + "name": "new AdminPostDiscountsDiscountRule", "variant": "signature", "kind": 16384, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the line item." - } - ] - }, "type": { "type": "reference", - "target": 446, - "name": "AdminPostDraftOrdersDraftOrderLineItemsItemReq", + "target": 256, + "name": "AdminPostDiscountsDiscountRule", "package": "@medusajs/medusa" } } ] }, { - "id": 452, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The optional key-value map with additional details about the Line Item." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 451, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity of the line item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 449, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the line item if `variant_id` is not provided." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 450, - "name": "unit_price", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The custom price of the line item. If a `variant_id` is supplied, the price provided here will override the variant's price." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 447 - ] - }, - { - "title": "Properties", - "children": [ - 452, - 451, - 449, - 450 - ] - } - ] - }, - { - "id": 414, - "name": "AdminPostDraftOrdersDraftOrderLineItemsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the line item to create." - } - ] - }, - "children": [ - { - "id": 415, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 416, - "name": "new AdminPostDraftOrdersDraftOrderLineItemsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the line item to create." - } - ] - }, - "type": { - "type": "reference", - "target": 414, - "name": "AdminPostDraftOrdersDraftOrderLineItemsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 421, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The optional key-value map with additional details about the Line Item." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 420, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity of the line item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 417, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the line item if `variant_id` is not provided." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "\"Custom item\"" - }, - { - "id": 418, - "name": "unit_price", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The custom price of the line item. If a `variant_id` is supplied, the price provided here will override the variant's price." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 419, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Product Variant associated with the line item. If the line item is custom, the `variant_id` should be omitted." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 415 - ] - }, - { - "title": "Properties", - "children": [ - 421, - 420, - 417, - 418, - 419 - ] - } - ] - }, - { - "id": 435, - "name": "AdminPostDraftOrdersDraftOrderReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the draft order to update." - } - ] - }, - "children": [ - { - "id": 436, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 437, - "name": "new AdminPostDraftOrdersDraftOrderReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the draft order to update." - } - ] - }, - "type": { - "type": "reference", - "target": 435, - "name": "AdminPostDraftOrdersDraftOrderReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 441, - "name": "billing_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Address to be used for billing purposes." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 3935, - "name": "AddressPayload", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 439, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The 2 character ISO code for the Country." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 444, - "name": "customer_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the customer this draft order is associated with." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 443, - "name": "discounts", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of Discount codes to add to the Draft Order." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4382, - "name": "Discount", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 440, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An email to be used in the Draft Order." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 445, - "name": "no_notification_order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 438, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Region to create the Draft Order in." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 442, - "name": "shipping_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Address to be used for shipping purposes." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 3935, - "name": "AddressPayload", - "package": "@medusajs/medusa" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 436 - ] - }, - { - "title": "Properties", - "children": [ - 441, - 439, - 444, - 443, - 440, - 445, - 438, - 442 - ] - } - ] - }, - { - "id": 400, - "name": "AdminPostDraftOrdersReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the draft order to create." - } - ] - }, - "children": [ - { - "id": 401, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 402, - "name": "new AdminPostDraftOrdersReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the draft order to create." - } - ] - }, - "type": { - "type": "reference", - "target": 400, - "name": "AdminPostDraftOrdersReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 405, - "name": "billing_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Address to be used for billing purposes." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 3935, - "name": "AddressPayload", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 410, - "name": "customer_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the customer this draft order is associated with." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 409, - "name": "discounts", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The discounts to add to the draft order" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4372, - "name": "Discount", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 404, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email of the customer of the draft order" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 407, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The draft order's line items." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4364, - "name": "Item", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 413, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The optional key-value map with additional details about the Draft Order." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 411, - "name": "no_notification_order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 408, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the region for the draft order" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 406, - "name": "shipping_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Address to be used for shipping purposes." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 3935, - "name": "AddressPayload", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 412, - "name": "shipping_methods", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The shipping methods for the draft order" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4376, - "name": "ShippingMethod", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 403, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The status of the draft order. The draft order's default status is `open`. It's changed to `completed` when its payment is marked as paid." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 401 - ] - }, - { - "title": "Properties", - "children": [ - 405, - 410, - 409, - 404, - 407, - 413, - 411, - 408, - 406, - 412, - 403 - ] - } - ] - }, - { - "id": 476, - "name": "AdminPostGiftCardsGiftCardReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the gift card." - } - ] - }, - "children": [ - { - "id": 477, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 478, - "name": "new AdminPostGiftCardsGiftCardReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the gift card." - } - ] - }, - "type": { - "type": "reference", - "target": 476, - "name": "AdminPostGiftCardsGiftCardReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 479, - "name": "balance", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value (excluding VAT) that the Gift Card should represent." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 481, - "name": "ends_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date and time at which the Gift Card should no longer be available." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 480, - "name": "is_disabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Gift Card is disabled on creation. If set to `true`, the gift card will not be available for customers." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 483, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 482, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Region in which the Gift Card can be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 477 - ] - }, - { - "title": "Properties", - "children": [ - 479, - 481, - 480, - 483, - 482 - ] - } - ] - }, - { - "id": 462, - "name": "AdminPostGiftCardsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the gift card to create." - } - ] - }, - "children": [ - { - "id": 463, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 464, - "name": "new AdminPostGiftCardsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the gift card to create." - } - ] - }, - "type": { - "type": "reference", - "target": 462, - "name": "AdminPostGiftCardsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 466, - "name": "ends_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date and time at which the Gift Card should no longer be available." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 467, - "name": "is_disabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Gift Card is disabled on creation. If set to `true`, the gift card will not be available for customers." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 469, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 468, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Region in which the Gift Card can be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 465, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value (excluding VAT) that the Gift Card should represent." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 463 - ] - }, - { - "title": "Properties", - "children": [ - 466, - 467, - 469, - 468, - 465 - ] - } - ] - }, - { - "id": 590, - "name": "AdminPostInventoryItemsInventoryItemParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 591, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 592, - "name": "new AdminPostInventoryItemsInventoryItemParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 590, - "name": "AdminPostInventoryItemsInventoryItemParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 593, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 594, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 591 - ] - }, - { - "title": "Properties", - "children": [ - 593, - 594 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 574, - "name": "AdminPostInventoryItemsInventoryItemReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attributes to update in an inventory item." - } - ] - }, - "children": [ - { - "id": 575, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 576, - "name": "new AdminPostInventoryItemsInventoryItemReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attributes to update in an inventory item." - } - ] - }, - "type": { - "type": "reference", - "target": 574, - "name": "AdminPostInventoryItemsInventoryItemReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 587, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The inventory item's description." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 583, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the Inventory Item. May be used in shipping rate calculations." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 579, - "name": "hs_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 584, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The length of the Inventory Item. May be used in shipping rate calculations." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 581, - "name": "material", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 580, - "name": "mid_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 578, - "name": "origin_country", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 589, - "name": "requires_shipping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the item requires shipping." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 577, - "name": "sku", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 588, - "name": "thumbnail", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The inventory item's thumbnail." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 586, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The inventory item's title." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 582, - "name": "weight", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The weight of the Inventory Item. May be used in shipping rate calculations." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 585, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the Inventory Item. May be used in shipping rate calculations." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 575 - ] - }, - { - "title": "Properties", - "children": [ - 587, - 583, - 579, - 584, - 581, - 580, - 578, - 589, - 577, - 588, - 586, - 582, - 585 - ] - } - ] - }, - { - "id": 600, - "name": "AdminPostInventoryItemsItemLocationLevelsLevelParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 601, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 602, - "name": "new AdminPostInventoryItemsItemLocationLevelsLevelParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 600, - "name": "AdminPostInventoryItemsItemLocationLevelsLevelParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 603, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 604, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 601 - ] - }, - { - "title": "Properties", - "children": [ - 603, - 604 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 595, - "name": "AdminPostInventoryItemsItemLocationLevelsLevelReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 596, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 597, - "name": "new AdminPostInventoryItemsItemLocationLevelsLevelReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 595, - "name": "AdminPostInventoryItemsItemLocationLevelsLevelReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 598, - "name": "incoming_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the incoming stock quantity of an inventory item at the given location ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 599, - "name": "stocked_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the total stock quantity of an inventory item at the given location ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 596 - ] - }, - { - "title": "Properties", - "children": [ - 598, - 599 - ] - } - ] - }, - { - "id": 537, - "name": "AdminPostInventoryItemsItemLocationLevelsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 538, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 539, - "name": "new AdminPostInventoryItemsItemLocationLevelsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 537, - "name": "AdminPostInventoryItemsItemLocationLevelsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 540, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 541, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 538 - ] - }, - { - "title": "Properties", - "children": [ - 540, - 541 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 531, - "name": "AdminPostInventoryItemsItemLocationLevelsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the location level to create." - } - ] - }, - "children": [ - { - "id": 532, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 533, - "name": "new AdminPostInventoryItemsItemLocationLevelsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the location level to create." - } - ] - }, - "type": { - "type": "reference", - "target": 531, - "name": "AdminPostInventoryItemsItemLocationLevelsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 536, - "name": "incoming_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the incoming stock quantity of the inventory item at this location" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 534, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the ID of the stock location" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 535, - "name": "stocked_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the stock quantity of the inventory item at this location" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 532 - ] - }, - { - "title": "Properties", - "children": [ - 536, - 534, - 535 - ] - } - ] - }, - { - "id": 526, - "name": "AdminPostInventoryItemsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 527, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 528, - "name": "new AdminPostInventoryItemsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 526, - "name": "AdminPostInventoryItemsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 529, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 530, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 527 - ] - }, - { - "title": "Properties", - "children": [ - 529, - 530 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 509, - "name": "AdminPostInventoryItemsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the inventory item to create." - } - ] - }, - "children": [ - { - "id": 510, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 511, - "name": "new AdminPostInventoryItemsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the inventory item to create." - } - ] - }, - "type": { - "type": "reference", - "target": 509, - "name": "AdminPostInventoryItemsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 523, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The inventory item's description." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 517, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the Inventory Item. May be used in shipping rate calculations." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 514, - "name": "hs_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 516, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The length of the Inventory Item. May be used in shipping rate calculations." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 521, - "name": "material", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 525, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 520, - "name": "mid_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 519, - "name": "origin_country", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 513, - "name": "sku", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique SKU of the associated Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 524, - "name": "thumbnail", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The inventory item's thumbnail." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 522, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The inventory item's title." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 512, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the variant to create the inventory item for." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 515, - "name": "weight", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The weight of the Inventory Item. May be used in shipping rate calculations." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 518, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the Inventory Item. May be used in shipping rate calculations." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 510 - ] - }, - { - "title": "Properties", - "children": [ - 523, - 517, - 514, - 516, - 521, - 525, - 520, - 519, - 513, - 524, - 522, - 512, - 515, - 518 - ] - } - ] - }, - { - "id": 618, - "name": "AdminPostInvitesInviteAcceptReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the invite to be accepted." - } - ] - }, - "children": [ - { - "id": 619, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 620, - "name": "new AdminPostInvitesInviteAcceptReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the invite to be accepted." - } - ] - }, - "type": { - "type": "reference", - "target": 618, - "name": "AdminPostInvitesInviteAcceptReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 621, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The token of the invite to accept. This is a unique token generated when the invite was created or resent." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 622, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the user to create." - } - ] - }, - "type": { - "type": "reference", - "target": 612, - "name": "AdminPostInvitesInviteAcceptUserReq", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 619 - ] - }, - { - "title": "Properties", - "children": [ - 621, - 622 - ] - } - ] - }, - { - "id": 612, - "name": "AdminPostInvitesInviteAcceptUserReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Details of the use accepting the invite." - } - ] - }, - "children": [ - { - "id": 613, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 614, - "name": "new AdminPostInvitesInviteAcceptUserReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 612, - "name": "AdminPostInvitesInviteAcceptUserReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 615, - "name": "first_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The invite's first name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 616, - "name": "last_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The invite's last name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 617, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The invite's password" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 613 - ] - }, - { - "title": "Properties", - "children": [ - 615, - 616, - 617 - ] - } - ] - }, - { - "id": 623, - "name": "AdminPostInvitesReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 624, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 625, - "name": "new AdminPostInvitesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 623, - "name": "AdminPostInvitesReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 627, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The role of the user to be created. This does not actually change the privileges of the user that is eventually created." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/user.ts", - "qualifiedName": "UserRoles" - }, - "name": "UserRoles", - "package": "@medusajs/medusa" - } - }, - { - "id": 626, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email associated with the invite. Once the invite is accepted, the email will be associated with the created user." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 624 - ] - }, - { - "title": "Properties", - "children": [ - 627, - 626 - ] - } - ] - }, - { - "id": 647, - "name": "AdminPostNotesNoteReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the note." - } - ] - }, - "children": [ - { - "id": 648, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 649, - "name": "new AdminPostNotesNoteReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the note." - } - ] - }, - "type": { - "type": "reference", - "target": 647, - "name": "AdminPostNotesNoteReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 650, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the Note." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 648 - ] - }, - { - "title": "Properties", - "children": [ - 650 - ] - } - ] - }, - { - "id": 635, - "name": "AdminPostNotesReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the note to be created." - } - ] - }, - "children": [ - { - "id": 636, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 637, - "name": "new AdminPostNotesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the note to be created." - } - ] - }, - "type": { - "type": "reference", - "target": 635, - "name": "AdminPostNotesReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 638, - "name": "resource_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the resource which the Note relates to. For example, an order ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 639, - "name": "resource_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of resource which the Note relates to. For example, `order`." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 640, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The content of the Note to create." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 636 - ] - }, - { - "title": "Properties", - "children": [ - 638, - 639, - 640 - ] - } - ] - }, - { - "id": 671, - "name": "AdminPostNotificationsNotificationResendReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The resend details." - } - ] - }, - "children": [ - { - "id": 672, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 673, - "name": "new AdminPostNotificationsNotificationResendReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The resend details." - } - ] - }, - "type": { - "type": "reference", - "target": 671, - "name": "AdminPostNotificationsNotificationResendReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 674, - "name": "to", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A new address or user identifier that the Notification should be sent to. If not provided, the previous `to` field of the notification will be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 672 - ] - }, - { - "title": "Properties", - "children": [ - 674 - ] - } - ] - }, - { - "id": 722, - "name": "AdminPostOrderEditsEditLineItemsLineItemReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to create or update of the line item change." - } - ] - }, - "children": [ - { - "id": 723, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 724, - "name": "new AdminPostOrderEditsEditLineItemsLineItemReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to create or update of the line item change." - } - ] - }, - "type": { - "type": "reference", - "target": 722, - "name": "AdminPostOrderEditsEditLineItemsLineItemReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 725, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity to update" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 723 - ] - }, - { - "title": "Properties", - "children": [ - 725 - ] - } - ] - }, - { - "id": 687, - "name": "AdminPostOrderEditsEditLineItemsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the line item change to create." - } - ] - }, - "children": [ - { - "id": 688, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 689, - "name": "new AdminPostOrderEditsEditLineItemsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the line item change to create." - } - ] - }, - "type": { - "type": "reference", - "target": 687, - "name": "AdminPostOrderEditsEditLineItemsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 692, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 691, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity of the item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 690, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product variant associated with the item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 688 - ] - }, - { - "title": "Properties", - "children": [ - 692, - 691, - 690 - ] - } - ] - }, - { - "id": 718, - "name": "AdminPostOrderEditsOrderEditReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the order edit." - } - ] - }, - "children": [ - { - "id": 719, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 720, - "name": "new AdminPostOrderEditsOrderEditReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the order edit." - } - ] - }, - "type": { - "type": "reference", - "target": 718, - "name": "AdminPostOrderEditsOrderEditReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 721, - "name": "internal_note", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional note to create or update in the order edit." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 719 - ] - }, - { - "title": "Properties", - "children": [ - 721 - ] - } - ] - }, - { - "id": 693, - "name": "AdminPostOrderEditsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the order edit to create." - } - ] - }, - "children": [ - { - "id": 694, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 695, - "name": "new AdminPostOrderEditsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the order edit to create." - } - ] - }, - "type": { - "type": "reference", - "target": 693, - "name": "AdminPostOrderEditsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 698, - "name": "created_by", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 697, - "name": "internal_note", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional note to associate with the order edit." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 696, - "name": "order_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the order to create the edit for." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 694 - ] - }, - { - "title": "Properties", - "children": [ - 698, - 697, - 696 - ] - } - ] - }, - { - "id": 714, - "name": "AdminPostOrderEditsRequestConfirmationReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 715, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 716, - "name": "new AdminPostOrderEditsRequestConfirmationReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 714, - "name": "AdminPostOrderEditsRequestConfirmationReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 717, - "name": "payment_collection_description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 715 - ] - }, - { - "title": "Properties", - "children": [ - 717 - ] - } - ] - }, - { - "id": 753, - "name": "AdminPostOrdersClaimCancel", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 754, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 755, - "name": "new AdminPostOrdersClaimCancel", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 753, - "name": "AdminPostOrdersClaimCancel", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 756, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 757, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 754 - ] - }, - { - "title": "Properties", - "children": [ - 756, - 757 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 769, - "name": "AdminPostOrdersClaimFulfillmentsCancelParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 770, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 771, - "name": "new AdminPostOrdersClaimFulfillmentsCancelParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 769, - "name": "AdminPostOrdersClaimFulfillmentsCancelParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 772, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 773, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 770 - ] - }, - { - "title": "Properties", - "children": [ - 772, - 773 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 748, - "name": "AdminPostOrdersOrderArchiveParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 749, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 750, - "name": "new AdminPostOrdersOrderArchiveParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 748, - "name": "AdminPostOrdersOrderArchiveParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 751, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 752, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 749 - ] - }, - { - "title": "Properties", - "children": [ - 751, - 752 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 779, - "name": "AdminPostOrdersOrderCancel", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 780, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 781, - "name": "new AdminPostOrdersOrderCancel", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 779, - "name": "AdminPostOrdersOrderCancel", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 782, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 783, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 780 - ] - }, - { - "title": "Properties", - "children": [ - 782, - 783 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 789, - "name": "AdminPostOrdersOrderCaptureParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 790, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 791, - "name": "new AdminPostOrdersOrderCaptureParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 789, - "name": "AdminPostOrdersOrderCaptureParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 792, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 793, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 790 - ] - }, - { - "title": "Properties", - "children": [ - 792, - 793 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 890, - "name": "AdminPostOrdersOrderClaimsClaimFulfillmentsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 891, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 892, - "name": "new AdminPostOrdersOrderClaimsClaimFulfillmentsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 890, - "name": "AdminPostOrdersOrderClaimsClaimFulfillmentsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 893, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 894, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 891 - ] - }, - { - "title": "Properties", - "children": [ - 893, - 894 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 884, - "name": "AdminPostOrdersOrderClaimsClaimFulfillmentsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 885, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 886, - "name": "new AdminPostOrdersOrderClaimsClaimFulfillmentsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 884, - "name": "AdminPostOrdersOrderClaimsClaimFulfillmentsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 889, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the fulfillment's location." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 887, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 888, - "name": "no_notification", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, no notification will be sent to the customer related to this Claim." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 885 - ] - }, - { - "title": "Properties", - "children": [ - 889, - 887, - 888 - ] - } - ] - }, - { - "id": 973, - "name": "AdminPostOrdersOrderClaimsClaimParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 974, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 975, - "name": "new AdminPostOrdersOrderClaimsClaimParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 973, - "name": "AdminPostOrdersOrderClaimsClaimParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 976, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 977, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 974 - ] - }, - { - "title": "Properties", - "children": [ - 976, - 977 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 966, - "name": "AdminPostOrdersOrderClaimsClaimReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 967, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 968, - "name": "new AdminPostOrdersOrderClaimsClaimReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 966, - "name": "AdminPostOrdersOrderClaimsClaimReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 969, - "name": "claim_items", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Claim Items that the Claim will consist of." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4507, - "name": "Item", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 972, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 971, - "name": "no_notification", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true no notification will be send related to this Swap." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 970, - "name": "shipping_methods", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Shipping Methods to send the additional Line Items with." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4516, - "name": "ShippingMethod", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 967 - ] - }, - { - "title": "Properties", - "children": [ - 969, - 972, - 971, - 970 - ] - } - ] - }, - { - "id": 822, - "name": "AdminPostOrdersOrderClaimsClaimShipmentsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 823, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 824, - "name": "new AdminPostOrdersOrderClaimsClaimShipmentsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 822, - "name": "AdminPostOrdersOrderClaimsClaimShipmentsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 825, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 826, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 823 - ] - }, - { - "title": "Properties", - "children": [ - 825, - 826 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 817, - "name": "AdminPostOrdersOrderClaimsClaimShipmentsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 818, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 819, - "name": "new AdminPostOrdersOrderClaimsClaimShipmentsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 817, - "name": "AdminPostOrdersOrderClaimsClaimShipmentsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 820, - "name": "fulfillment_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Fulfillment." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 821, - "name": "tracking_numbers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of tracking numbers for the shipment." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 818 - ] - }, - { - "title": "Properties", - "children": [ - 820, - 821 - ] - } - ] - }, - { - "id": 812, - "name": "AdminPostOrdersOrderClaimsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 813, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 814, - "name": "new AdminPostOrdersOrderClaimsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 812, - "name": "AdminPostOrdersOrderClaimsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 815, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 816, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 813 - ] - }, - { - "title": "Properties", - "children": [ - 815, - 816 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 799, - "name": "AdminPostOrdersOrderClaimsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the claim to be created." - } - ] - }, - "children": [ - { - "id": 800, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 801, - "name": "new AdminPostOrdersOrderClaimsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the claim to be created." - } - ] - }, - "type": { - "type": "reference", - "target": 799, - "name": "AdminPostOrdersOrderClaimsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 805, - "name": "additional_items", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new items to send to the Customer. This is only used if the claim's type is `replace`." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4437, - "name": "AdditionalItem", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 803, - "name": "claim_items", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Claim Items that the Claim will consist of." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4423, - "name": "Item", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 811, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 809, - "name": "no_notification", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true no notification will be send related to this Claim." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 807, - "name": "refund_amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount to refund the customer. This is used when the claim's type is `refund`." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 810, - "name": "return_location_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the location used for the associated return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 804, - "name": "return_shipping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Optional details for the Return Shipping Method, if the items are to be sent back. Providing this field will result in a return being created and associated with the claim." - } - ] - }, - "type": { - "type": "reference", - "target": 4432, - "name": "ReturnShipping", - "package": "@medusajs/medusa" - } - }, - { - "id": 808, - "name": "shipping_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional shipping address to send the claimed items to. If not provided, the parent order's shipping address will be used." - } - ] - }, - "type": { - "type": "reference", - "target": 3935, - "name": "AddressPayload", - "package": "@medusajs/medusa" - } - }, - { - "id": 806, - "name": "shipping_methods", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Shipping Methods to send the additional Line Items with. This is only used if the claim's type is `replace`." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4442, - "name": "ShippingMethod", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 802, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the Claim. This will determine how the Claim is treated: `replace` Claims will result in a Fulfillment with new items being created, while a `refund` Claim will refund the amount paid for the claimed items." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "replace" - }, - { - "type": "literal", - "value": "refund" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 800 - ] - }, - { - "title": "Properties", - "children": [ - 805, - 803, - 811, - 809, - 807, - 810, - 804, - 808, - 806, - 802 - ] - } - ] - }, - { - "id": 794, - "name": "AdminPostOrdersOrderCompleteParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 795, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 796, - "name": "new AdminPostOrdersOrderCompleteParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 794, - "name": "AdminPostOrdersOrderCompleteParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 797, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 798, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 795 - ] - }, - { - "title": "Properties", - "children": [ - 797, - 798 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 764, - "name": "AdminPostOrdersOrderFulfillementsCancelParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 765, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 766, - "name": "new AdminPostOrdersOrderFulfillementsCancelParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 764, - "name": "AdminPostOrdersOrderFulfillementsCancelParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 767, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 768, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 765 - ] - }, - { - "title": "Properties", - "children": [ - 767, - 768 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 841, - "name": "AdminPostOrdersOrderFulfillmentsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 842, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 843, - "name": "new AdminPostOrdersOrderFulfillmentsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 841, - "name": "AdminPostOrdersOrderFulfillmentsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 844, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 845, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 842 - ] - }, - { - "title": "Properties", - "children": [ - 844, - 845 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 834, - "name": "AdminPostOrdersOrderFulfillmentsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the fulfillment to be created." - } - ] - }, - "children": [ - { - "id": 835, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 836, - "name": "new AdminPostOrdersOrderFulfillmentsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the fulfillment to be created." - } - ] - }, - "type": { - "type": "reference", - "target": 834, - "name": "AdminPostOrdersOrderFulfillmentsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 837, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Line Items to include in the Fulfillment." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4449, - "name": "Item", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 838, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the location where the items will be fulfilled from." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 840, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 839, - "name": "no_notification", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, no notification will be sent to the customer related to this fulfillment." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 835 - ] - }, - { - "title": "Properties", - "children": [ - 837, - 838, - 840, - 839 - ] - } - ] - }, - { - "id": 991, - "name": "AdminPostOrdersOrderParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to configure the retrieved order." - } - ] - }, - "children": [ - { - "id": 992, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 993, - "name": "new AdminPostOrdersOrderParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 991, - "name": "AdminPostOrdersOrderParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 994, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 995, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 992 - ] - }, - { - "title": "Properties", - "children": [ - 994, - 995 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 946, - "name": "AdminPostOrdersOrderRefundsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 947, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 948, - "name": "new AdminPostOrdersOrderRefundsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 946, - "name": "AdminPostOrdersOrderRefundsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 949, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 950, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 947 - ] - }, - { - "title": "Properties", - "children": [ - 949, - 950 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 939, - "name": "AdminPostOrdersOrderRefundsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the order refund." - } - ] - }, - "children": [ - { - "id": 940, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 941, - "name": "new AdminPostOrdersOrderRefundsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the order refund." - } - ] - }, - "type": { - "type": "reference", - "target": 939, - "name": "AdminPostOrdersOrderRefundsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 942, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount to refund. It should be less than or equal the `refundable_amount` of the order." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 945, - "name": "no_notification", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, no notification will be sent to the customer related to this Refund." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 944, - "name": "note", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A note with additional details about the Refund." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 943, - "name": "reason", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The reason for the Refund." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 940 - ] - }, - { - "title": "Properties", - "children": [ - 942, - 945, - 944, - 943 - ] - } - ] - }, - { - "id": 978, - "name": "AdminPostOrdersOrderReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the order." - } - ] - }, - "children": [ - { - "id": 979, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 980, - "name": "new AdminPostOrdersOrderReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the order." - } - ] - }, - "type": { - "type": "reference", - "target": 978, - "name": "AdminPostOrdersOrderReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 982, - "name": "billing_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The order's billing address" - } - ] - }, - "type": { - "type": "reference", - "target": 3935, - "name": "AddressPayload", - "package": "@medusajs/medusa" - } - }, - { - "id": 987, - "name": "customer_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the customer associated with the order." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 986, - "name": "discounts", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The discounts applied to the order" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - }, - { - "id": 981, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The email associated with the order" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 984, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The line items of the order" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - }, - { - "id": 990, - "name": "no_notification", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, no notification will be sent to the customer related to this order." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 988, - "name": "payment_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The payment method chosen for the order." - } - ] - }, - "type": { - "type": "reference", - "target": 4523, - "name": "PaymentMethod", - "package": "@medusajs/medusa" - } - }, - { - "id": 985, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the region that the order is associated with." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 983, - "name": "shipping_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The order's shipping address" - } - ] - }, - "type": { - "type": "reference", - "target": 3935, - "name": "AddressPayload", - "package": "@medusajs/medusa" - } - }, - { - "id": 989, - "name": "shipping_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Shipping Method used for shipping the order." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4528, - "name": "ShippingMethod", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 979 - ] - }, - { - "title": "Properties", - "children": [ - 982, - 987, - 986, - 981, - 984, - 990, - 988, - 985, - 983, - 989 - ] - } - ] - }, - { - "id": 961, - "name": "AdminPostOrdersOrderReturnsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 962, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 963, - "name": "new AdminPostOrdersOrderReturnsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 961, - "name": "AdminPostOrdersOrderReturnsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 964, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 965, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 962 - ] - }, - { - "title": "Properties", - "children": [ - 964, - 965 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 951, - "name": "AdminPostOrdersOrderReturnsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the requested return." - } - ] - }, - "children": [ - { - "id": 952, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 953, - "name": "new AdminPostOrdersOrderReturnsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the requested return." - } - ] - }, - "type": { - "type": "reference", - "target": 951, - "name": "AdminPostOrdersOrderReturnsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 954, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The line items that will be returned." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4495, - "name": "OrdersReturnItem", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 960, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the location used for the return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 958, - "name": "no_notification", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, no notification will be sent to the customer related to this Return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 956, - "name": "note", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional note with information about the Return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 957, - "name": "receive_now", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A flag to indicate if the Return should be registerd as received immediately." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 959, - "name": "refund", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount to refund." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 955, - "name": "return_shipping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Shipping Method to be used to handle the return shipment." - } - ] - }, - "type": { - "type": "reference", - "target": 4502, - "name": "ReturnShipping", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 952 - ] - }, - { - "title": "Properties", - "children": [ - 954, - 960, - 958, - 956, - 957, - 959, - 955 - ] - } - ] - }, - { - "id": 852, - "name": "AdminPostOrdersOrderShipmentParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 853, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 854, - "name": "new AdminPostOrdersOrderShipmentParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 852, - "name": "AdminPostOrdersOrderShipmentParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 855, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 856, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 853 - ] - }, - { - "title": "Properties", - "children": [ - 855, - 856 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 846, - "name": "AdminPostOrdersOrderShipmentReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the shipment to create." - } - ] - }, - "children": [ - { - "id": 847, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 848, - "name": "new AdminPostOrdersOrderShipmentReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the shipment to create." - } - ] - }, - "type": { - "type": "reference", - "target": 846, - "name": "AdminPostOrdersOrderShipmentReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 849, - "name": "fulfillment_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Fulfillment." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 851, - "name": "no_notification", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true no notification will be send related to this Shipment." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 850, - "name": "tracking_numbers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tracking numbers for the shipment." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 847 - ] - }, - { - "title": "Properties", - "children": [ - 849, - 851, - 850 - ] - } - ] - }, - { - "id": 743, - "name": "AdminPostOrdersOrderShippingMethodsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 744, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 745, - "name": "new AdminPostOrdersOrderShippingMethodsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 743, - "name": "AdminPostOrdersOrderShippingMethodsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 746, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 747, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 744 - ] - }, - { - "title": "Properties", - "children": [ - 746, - 747 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 737, - "name": "AdminPostOrdersOrderShippingMethodsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The shipping method's details." - } - ] - }, - "children": [ - { - "id": 738, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 739, - "name": "new AdminPostOrdersOrderShippingMethodsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The shipping method's details." - } - ] - }, - "type": { - "type": "reference", - "target": 737, - "name": "AdminPostOrdersOrderShippingMethodsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 742, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data required for the Shipping Option to create a Shipping Method. This depends on the Fulfillment Provider." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 741, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Shipping Option to create the Shipping Method from." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 740, - "name": "price", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price (excluding VAT) that should be charged for the Shipping Method" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 738 - ] - }, - { - "title": "Properties", - "children": [ - 742, - 741, - 740 - ] - } - ] - }, - { - "id": 774, - "name": "AdminPostOrdersOrderSwapFulfillementsCancelParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 775, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 776, - "name": "new AdminPostOrdersOrderSwapFulfillementsCancelParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 774, - "name": "AdminPostOrdersOrderSwapFulfillementsCancelParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 777, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 778, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 775 - ] - }, - { - "title": "Properties", - "children": [ - 777, - 778 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 868, - "name": "AdminPostOrdersOrderSwapsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 869, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 870, - "name": "new AdminPostOrdersOrderSwapsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 868, - "name": "AdminPostOrdersOrderSwapsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 871, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 872, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 869 - ] - }, - { - "title": "Properties", - "children": [ - 871, - 872 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 857, - "name": "AdminPostOrdersOrderSwapsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the swap to create." - } - ] - }, - "children": [ - { - "id": 858, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 859, - "name": "new AdminPostOrdersOrderSwapsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the swap to create." - } - ] - }, - "type": { - "type": "reference", - "target": 857, - "name": "AdminPostOrdersOrderSwapsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 863, - "name": "additional_items", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The new items to send to the Customer." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4466, - "name": "AdditionalItem", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 867, - "name": "allow_backorder", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, swaps can be completed with items out of stock" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 864, - "name": "custom_shipping_options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of custom shipping options to potentially create a Shipping Method from to send the additional items." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4471, - "name": "CustomShippingOption", - "package": "@medusajs/medusa" - } - }, - "defaultValue": "[]" - }, - { - "id": 865, - "name": "no_notification", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, no notification will be sent to the customer related to this Swap." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 860, - "name": "return_items", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Line Items to associate with the swap's return." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4454, - "name": "ReturnItem", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 866, - "name": "return_location_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the location used for the associated return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 861, - "name": "return_shipping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The shipping method associated with the swap's return." - } - ] - }, - "type": { - "type": "reference", - "target": 4461, - "name": "ReturnShipping", - "package": "@medusajs/medusa" - } - }, - { - "id": 862, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the sales channel associated with the swap." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 858 - ] - }, - { - "title": "Properties", - "children": [ - 863, - 867, - 864, - 865, - 860, - 866, - 861, - 862 - ] - } - ] - }, - { - "id": 901, - "name": "AdminPostOrdersOrderSwapsSwapFulfillmentsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 902, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 903, - "name": "new AdminPostOrdersOrderSwapsSwapFulfillmentsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 901, - "name": "AdminPostOrdersOrderSwapsSwapFulfillmentsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 904, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 905, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 902 - ] - }, - { - "title": "Properties", - "children": [ - 904, - 905 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 895, - "name": "AdminPostOrdersOrderSwapsSwapFulfillmentsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 896, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 897, - "name": "new AdminPostOrdersOrderSwapsSwapFulfillmentsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 895, - "name": "AdminPostOrdersOrderSwapsSwapFulfillmentsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 900, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the fulfillment's location." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 898, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 899, - "name": "no_notification", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, no notification will be sent to the customer related to this swap." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 896 - ] - }, - { - "title": "Properties", - "children": [ - 900, - 898, - 899 - ] - } - ] - }, - { - "id": 934, - "name": "AdminPostOrdersOrderSwapsSwapProcessPaymentParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 935, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 936, - "name": "new AdminPostOrdersOrderSwapsSwapProcessPaymentParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 934, - "name": "AdminPostOrdersOrderSwapsSwapProcessPaymentParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 937, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 938, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 935 - ] - }, - { - "title": "Properties", - "children": [ - 937, - 938 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 879, - "name": "AdminPostOrdersOrderSwapsSwapShipmentsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 880, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 881, - "name": "new AdminPostOrdersOrderSwapsSwapShipmentsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 879, - "name": "AdminPostOrdersOrderSwapsSwapShipmentsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 882, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 883, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 880 - ] - }, - { - "title": "Properties", - "children": [ - 882, - 883 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 873, - "name": "AdminPostOrdersOrderSwapsSwapShipmentsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 874, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 875, - "name": "new AdminPostOrdersOrderSwapsSwapShipmentsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 873, - "name": "AdminPostOrdersOrderSwapsSwapShipmentsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 876, - "name": "fulfillment_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Fulfillment." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 878, - "name": "no_notification", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to true no notification will be sent related to this Claim." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 877, - "name": "tracking_numbers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tracking numbers for the shipment." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "[]" - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 874 - ] - }, - { - "title": "Properties", - "children": [ - 876, - 878, - 877 - ] - } - ] - }, - { - "id": 784, - "name": "AdminPostOrdersSwapCancelParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 785, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 786, - "name": "new AdminPostOrdersSwapCancelParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 784, - "name": "AdminPostOrdersSwapCancelParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 787, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 788, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 785 - ] - }, - { - "title": "Properties", - "children": [ - 787, - 788 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1028, - "name": "AdminPostPaymentRefundsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the refund to create." - } - ] - }, - "children": [ - { - "id": 1029, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1030, - "name": "new AdminPostPaymentRefundsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the refund to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1028, - "name": "AdminPostPaymentRefundsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1031, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount to refund." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1033, - "name": "note", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A note with additional details about the Refund." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1032, - "name": "reason", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The reason for the Refund." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/refund.ts", - "qualifiedName": "RefundReason" - }, - "name": "RefundReason", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1029 - ] - }, - { - "title": "Properties", - "children": [ - 1031, - 1033, - 1032 - ] - } - ] - }, - { - "id": 1082, - "name": "AdminPostPriceListPricesPricesReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the prices to add." - } - ] - }, - "children": [ - { - "id": 1083, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1084, - "name": "new AdminPostPriceListPricesPricesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the prices to add." - } - ] - }, - "type": { - "type": "reference", - "target": 1082, - "name": "AdminPostPriceListPricesPricesReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1086, - "name": "override", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, the prices will replace all existing prices associated with the Price List." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1085, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prices to update or add." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4080, - "name": "AdminPriceListPricesUpdateReq", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1083 - ] - }, - { - "title": "Properties", - "children": [ - 1086, - 1085 - ] - } - ] - }, - { - "id": 1146, - "name": "AdminPostPriceListsPriceListPriceListReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the payment collection." - } - ] - }, - "children": [ - { - "id": 1147, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1148, - "name": "new AdminPostPriceListsPriceListPriceListReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the payment collection." - } - ] - }, - "type": { - "type": "reference", - "target": 1146, - "name": "AdminPostPriceListsPriceListPriceListReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1156, - "name": "customer_groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of customer groups that the Price List applies to." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4546, - "name": "CustomerGroup", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1150, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the Price List." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1152, - "name": "ends_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone that the Price List ends being valid." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 1157, - "name": "includes_tax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tax included in prices of price list" - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "tax_inclusive_pricing", - "tag": "@featureFlag" - } - ] - }, - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "tax_inclusive_pricing", - "tag": "@featureFlag" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1149, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Price List" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1155, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prices of the Price List." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4080, - "name": "AdminPriceListPricesUpdateReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1151, - "name": "starts_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone that the Price List starts being valid." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 1153, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The status of the Price List. If the status is set to `draft`, the prices created in the price list will not be available of the customer." - } - ] - }, - "type": { - "type": "reference", - "target": 4536, - "name": "PriceListStatus", - "package": "@medusajs/utils" - } - }, - { - "id": 1154, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the Price List." - } - ] - }, - "type": { - "type": "reference", - "target": 4539, - "name": "PriceListType", - "package": "@medusajs/utils" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1147 - ] - }, - { - "title": "Properties", - "children": [ - 1156, - 1150, - 1152, - 1157, - 1149, - 1155, - 1151, - 1153, - 1154 - ] - } - ] - }, - { - "id": 1087, - "name": "AdminPostPriceListsPriceListReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the price list to create." - } - ] - }, - "children": [ - { - "id": 1088, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1089, - "name": "new AdminPostPriceListsPriceListReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the price list to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1087, - "name": "AdminPostPriceListsPriceListReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1097, - "name": "customer_groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of customer groups that the Price List applies to." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4542, - "name": "CustomerGroup", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1091, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the Price List." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1093, - "name": "ends_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone that the Price List ends being valid." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1098, - "name": "includes_tax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tax included in prices of price list" - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "tax_inclusive_pricing", - "tag": "@featureFlag" - } - ] - }, - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "tax_inclusive_pricing", - "tag": "@featureFlag" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1090, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Price List." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1096, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prices of the Price List." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4090, - "name": "AdminPriceListPricesCreateReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1092, - "name": "starts_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone that the Price List starts being valid." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1094, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The status of the Price List. If the status is set to `draft`, the prices created in the price list will not be available of the customer." - } - ] - }, - "type": { - "type": "reference", - "target": 4536, - "name": "PriceListStatus", - "package": "@medusajs/utils" - } - }, - { - "id": 1095, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the Price List." - } - ] - }, - "type": { - "type": "reference", - "target": 4539, - "name": "PriceListType", - "package": "@medusajs/utils" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1088 - ] - }, - { - "title": "Properties", - "children": [ - 1097, - 1091, - 1093, - 1098, - 1090, - 1096, - 1092, - 1094, - 1095 - ] - } - ] - }, - { - "id": 1213, - "name": "AdminPostProductCategoriesCategoryParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1214, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1215, - "name": "new AdminPostProductCategoriesCategoryParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1213, - "name": "AdminPostProductCategoriesCategoryParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 1216, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 1217, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1214 - ] - }, - { - "title": "Properties", - "children": [ - 1216, - 1217 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1222, - "name": "AdminPostProductCategoriesCategoryProductsBatchParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1223, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1224, - "name": "new AdminPostProductCategoriesCategoryProductsBatchParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1222, - "name": "AdminPostProductCategoriesCategoryProductsBatchParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 1225, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 1226, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1223 - ] - }, - { - "title": "Properties", - "children": [ - 1225, - 1226 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1218, - "name": "AdminPostProductCategoriesCategoryProductsBatchReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to add to the product category." - } - ] - }, - "children": [ - { - "id": 1219, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1220, - "name": "new AdminPostProductCategoriesCategoryProductsBatchReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to add to the product category." - } - ] - }, - "type": { - "type": "reference", - "target": 1218, - "name": "AdminPostProductCategoriesCategoryProductsBatchReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1221, - "name": "product_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the products to add to the product category" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4558, - "name": "ProductBatchProductCategory", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1219 - ] - }, - { - "title": "Properties", - "children": [ - 1221 - ] - } - ] - }, - { - "id": 1202, - "name": "AdminPostProductCategoriesCategoryReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the product category." - } - ] - }, - "children": [ - { - "id": 1203, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1204, - "name": "new AdminPostProductCategoriesCategoryReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the product category." - } - ] - }, - "type": { - "type": "reference", - "target": 1202, - "name": "AdminPostProductCategoriesCategoryReq", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4552, - "name": "AdminProductCategoriesReqBase.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4551, - "name": "AdminProductCategoriesReqBase.constructor" - } - }, - { - "id": 1209, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional text field to describe the Product Category by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4553, - "name": "AdminProductCategoriesReqBase.description" - } - }, - { - "id": 1206, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A handle to be used in slugs." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": 4554, - "name": "AdminProductCategoriesReqBase.handle" - } - }, - { - "id": 1211, - "name": "is_active", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A flag to make product category visible/hidden in the store front" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 4556, - "name": "AdminProductCategoriesReqBase.is_active" - } - }, - { - "id": 1210, - "name": "is_internal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A flag to make product category an internal category for admins" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 4555, - "name": "AdminProductCategoriesReqBase.is_internal" - } - }, - { - "id": 1208, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1205, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name to identify the Product Category by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1212, - "name": "parent_category_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the parent product category" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 4557, - "name": "AdminProductCategoriesReqBase.parent_category_id" - } - }, - { - "id": 1207, - "name": "rank", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The rank of the category in the tree node (starting from 0)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1203 - ] - }, - { - "title": "Properties", - "children": [ - 1209, - 1206, - 1211, - 1210, - 1208, - 1205, - 1212, - 1207 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4550, - "name": "AdminProductCategoriesReqBase", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1197, - "name": "AdminPostProductCategoriesParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1198, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1199, - "name": "new AdminPostProductCategoriesParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1197, - "name": "AdminPostProductCategoriesParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 1200, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 1201, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1198 - ] - }, - { - "title": "Properties", - "children": [ - 1200, - 1201 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1187, - "name": "AdminPostProductCategoriesReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the product category to create." - } - ] - }, - "children": [ - { - "id": 1188, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1189, - "name": "new AdminPostProductCategoriesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the product category to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1187, - "name": "AdminPostProductCategoriesReq", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4552, - "name": "AdminProductCategoriesReqBase.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4551, - "name": "AdminProductCategoriesReqBase.constructor" - } - }, - { - "id": 1192, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the product category." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4553, - "name": "AdminProductCategoriesReqBase.description" - } - }, - { - "id": 1193, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The handle of the product category. If none is provided, the kebab-case version of the name will be used. This field can be used as a slug in URLs." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4554, - "name": "AdminProductCategoriesReqBase.handle" - } - }, - { - "id": 1195, - "name": "is_active", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `false`, the product category will not be available in the storefront." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 4556, - "name": "AdminProductCategoriesReqBase.is_active" - } - }, - { - "id": 1194, - "name": "is_internal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, the product category will only be available to admins." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 4555, - "name": "AdminProductCategoriesReqBase.is_internal" - } - }, - { - "id": 1191, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1190, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the product category" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1196, - "name": "parent_category_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the parent product category" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 4557, - "name": "AdminProductCategoriesReqBase.parent_category_id" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1188 - ] - }, - { - "title": "Properties", - "children": [ - 1192, - 1193, - 1195, - 1194, - 1191, - 1190, - 1196 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4550, - "name": "AdminProductCategoriesReqBase", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1440, - "name": "AdminPostProductsProductMetadataReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1441, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1442, - "name": "new AdminPostProductsProductMetadataReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1440, - "name": "AdminPostProductsProductMetadataReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1443, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The metadata key" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1444, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The metadata value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1441 - ] - }, - { - "title": "Properties", - "children": [ - 1443, - 1444 - ] - } - ] - }, - { - "id": 1445, - "name": "AdminPostProductsProductOptionsOption", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1446, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1447, - "name": "new AdminPostProductsProductOptionsOption", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1445, - "name": "AdminPostProductsProductOptionsOption", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1448, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Product Option" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1446 - ] - }, - { - "title": "Properties", - "children": [ - 1448 - ] - } - ] - }, - { - "id": 1348, - "name": "AdminPostProductsProductOptionsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the product option to create." - } - ] - }, - "children": [ - { - "id": 1349, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1350, - "name": "new AdminPostProductsProductOptionsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the product option to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1348, - "name": "AdminPostProductsProductOptionsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1351, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title the Product Option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1349 - ] - }, - { - "title": "Properties", - "children": [ - 1351 - ] - } - ] - }, - { - "id": 1449, - "name": "AdminPostProductsProductReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the product." - } - ] - }, - "children": [ - { - "id": 1450, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1451, - "name": "new AdminPostProductsProductReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the product." - } - ] - }, - "type": { - "type": "reference", - "target": 1449, - "name": "AdminPostProductsProductReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1464, - "name": "categories", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product categories to add the Product to." - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "product_categories", - "tag": "@featureFlag" - } - ] - }, - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "product_categories", - "tag": "@featureFlag" - } - ] - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4579, - "name": "ProductProductCategoryReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1461, - "name": "collection_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Product Collection the Product belongs to." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1454, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1455, - "name": "discountable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A flag to indicate if discounts can be applied to the Line Items generated from this Product" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1458, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique handle to identify the Product by. If not provided, the kebab-case version of the product title will be used. This can be used as a slug in URLs." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1468, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1470, - "name": "hs_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Harmonized System code of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1456, - "name": "images", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of images of the Product. Each value in the array is a URL to the image. You can use the upload API Routes to upload the image and obtain a URL." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1467, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The length of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1473, - "name": "material", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The material composition of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1474, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1472, - "name": "mid_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Manufacturer Identification code of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1471, - "name": "origin_country", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The country of origin of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1463, - "name": "sales_channels", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sales channels to associate the Product with." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 4575, - "name": "ProductSalesChannelReq", - "package": "@medusajs/medusa" - } - } - ] - } - }, - { - "id": 1459, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The status of the product. The product is shown to the customer only if its status is `published`." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product.ts", - "qualifiedName": "ProductStatus" - }, - "name": "ProductStatus", - "package": "@medusajs/medusa" - } - }, - { - "id": 1453, - "name": "subtitle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The subtitle of the Product" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1462, - "name": "tags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product Tags to associate the Product with." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4570, - "name": "ProductTagReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1457, - "name": "thumbnail", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The thumbnail to use for the Product. The value is a URL to the thumbnail. You can use the upload API Routes to upload the thumbnail and obtain a URL." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1452, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Product" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1460, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Product Type to associate the Product with." - } - ] - }, - "type": { - "type": "reference", - "target": 4565, - "name": "ProductTypeReq", - "package": "@medusajs/medusa" - } - }, - { - "id": 1465, - "name": "variants", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of Product Variants to create with the Product. Each product variant must have a unique combination of Product Option values." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4643, - "name": "ProductVariantReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1466, - "name": "weight", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The weight of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1469, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1450 - ] - }, - { - "title": "Properties", - "children": [ - 1464, - 1461, - 1454, - 1455, - 1458, - 1468, - 1470, - 1456, - 1467, - 1473, - 1474, - 1472, - 1471, - 1463, - 1459, - 1453, - 1462, - 1457, - 1452, - 1460, - 1465, - 1466, - 1469 - ] - } - ] - }, - { - "id": 1380, - "name": "AdminPostProductsProductVariantsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the product variant to create." - } - ] - }, - "children": [ - { - "id": 1381, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1382, - "name": "new AdminPostProductsProductVariantsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the product variant to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1380, - "name": "AdminPostProductsProductVariantsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1390, - "name": "allow_backorder", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the product variant can be purchased when out of stock." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1387, - "name": "barcode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A generic GTIN field of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1385, - "name": "ean", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The EAN number of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1394, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1388, - "name": "hs_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Harmonized System code of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1389, - "name": "inventory_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount of stock kept of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 1393, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The length of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1391, - "name": "manage_inventory", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether Medusa should keep track of the inventory of this product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 1398, - "name": "material", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The material composition of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1399, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1397, - "name": "mid_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Manufacturer Identification code of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1401, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of Product Option values that the variant corresponds to." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4617, - "name": "ProductVariantOptionReq", - "package": "@medusajs/medusa" - } - }, - "defaultValue": "[]" - }, - { - "id": 1396, - "name": "origin_country", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The country of origin of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1400, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product variant prices. A product variant can have different prices for each region or currency code." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4609, - "name": "ProductVariantPricesCreateReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1384, - "name": "sku", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique SKU of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1383, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1386, - "name": "upc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The UPC number of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1392, - "name": "weight", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The wieght of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1395, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1381 - ] - }, - { - "title": "Properties", - "children": [ - 1390, - 1387, - 1385, - 1394, - 1388, - 1389, - 1393, - 1391, - 1398, - 1399, - 1397, - 1401, - 1396, - 1400, - 1384, - 1383, - 1386, - 1392, - 1395 - ] - } - ] - }, - { - "id": 1475, - "name": "AdminPostProductsProductVariantsVariantReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1476, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1477, - "name": "new AdminPostProductsProductVariantsVariantReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1475, - "name": "AdminPostProductsProductVariantsVariantReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1485, - "name": "allow_backorder", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the product variant can be purchased when out of stock." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1482, - "name": "barcode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A generic GTIN field of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1480, - "name": "ean", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The EAN number of the item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1489, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1483, - "name": "hs_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Harmonized System code of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1484, - "name": "inventory_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount of stock kept of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1488, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The length of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1486, - "name": "manage_inventory", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether Medusa should keep track of the inventory of this product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1493, - "name": "material", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The material composition of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1494, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1492, - "name": "mid_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Manufacturer Identification code of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1496, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of Product Option values that the variant corresponds to." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4675, - "name": "ProductVariantOptionReq", - "package": "@medusajs/medusa" - } - }, - "defaultValue": "[]" - }, - { - "id": 1491, - "name": "origin_country", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The country of origin of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1495, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product variant prices. A product variant can have different prices for each region or currency code." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4666, - "name": "ProductVariantPricesUpdateReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1479, - "name": "sku", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique SKU of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1478, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1481, - "name": "upc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The UPC number of the item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1487, - "name": "weight", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The weight of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1490, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1476 - ] - }, - { - "title": "Properties", - "children": [ - 1485, - 1482, - 1480, - 1489, - 1483, - 1484, - 1488, - 1486, - 1493, - 1494, - 1492, - 1496, - 1491, - 1495, - 1479, - 1478, - 1481, - 1487, - 1490 - ] - } - ] - }, - { - "id": 1352, - "name": "AdminPostProductsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the product to create." - } - ] - }, - "children": [ - { - "id": 1353, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1354, - "name": "new AdminPostProductsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the product to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1352, - "name": "AdminPostProductsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1368, - "name": "categories", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product categories to add the Product to." - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "product_categories", - "tag": "@featureFlag" - } - ] - }, - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "product_categories", - "tag": "@featureFlag" - } - ] - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4579, - "name": "ProductProductCategoryReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1365, - "name": "collection_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Product Collection the Product belongs to." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1357, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1359, - "name": "discountable", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A flag to indicate if discounts can be applied to the Line Items generated from this Product" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "true" - }, - { - "id": 1362, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique handle to identify the Product by. If not provided, the kebab-case version of the product title will be used. This can be used as a slug in URLs." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1373, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1375, - "name": "hs_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Harmonized System code of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1360, - "name": "images", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of images of the Product. Each value in the array is a URL to the image. You can use the upload API Routes to upload the image and obtain a URL." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1358, - "name": "is_giftcard", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A flag to indicate if the Product represents a Gift Card. Purchasing Products with this flag set to `true` will result in a Gift Card being created." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 1372, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The length of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1378, - "name": "material", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The material composition of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1379, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1377, - "name": "mid_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Manufacturer Identification code of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1369, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Options that the Product should have. A new product option will be created for every item in the array." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4583, - "name": "ProductOptionReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1376, - "name": "origin_country", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The country of origin of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1367, - "name": "sales_channels", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sales channels to associate the Product with." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4575, - "name": "ProductSalesChannelReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1363, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The status of the product. The product is shown to the customer only if its status is `published`." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product.ts", - "qualifiedName": "ProductStatus" - }, - "name": "ProductStatus", - "package": "@medusajs/medusa" - }, - "defaultValue": "ProductStatus.DRAFT" - }, - { - "id": 1356, - "name": "subtitle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The subtitle of the Product" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1366, - "name": "tags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product Tags to associate the Product with." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4570, - "name": "ProductTagReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1361, - "name": "thumbnail", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The thumbnail to use for the Product. The value is a URL to the thumbnail. You can use the upload API Routes to upload the thumbnail and obtain a URL." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1355, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Product" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1364, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Product Type to associate the Product with." - } - ] - }, - "type": { - "type": "reference", - "target": 4565, - "name": "ProductTypeReq", - "package": "@medusajs/medusa" - } - }, - { - "id": 1370, - "name": "variants", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of Product Variants to create with the Product. Each product variant must have a unique combination of Product Option values." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4587, - "name": "ProductVariantReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1371, - "name": "weight", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The weight of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1374, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1353 - ] - }, - { - "title": "Properties", - "children": [ - 1368, - 1365, - 1357, - 1359, - 1362, - 1373, - 1375, - 1360, - 1358, - 1372, - 1378, - 1379, - 1377, - 1369, - 1376, - 1367, - 1363, - 1356, - 1366, - 1361, - 1355, - 1364, - 1370, - 1371, - 1374 - ] - } - ] - }, - { - "id": 78, - "name": "AdminPostProductsToCollectionReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to add to the collection." - } - ] - }, - "children": [ - { - "id": 79, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 80, - "name": "new AdminPostProductsToCollectionReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to add to the collection." - } - ] - }, - "type": { - "type": "reference", - "target": 78, - "name": "AdminPostProductsToCollectionReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 81, - "name": "product_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of Product IDs to add to the Product Collection." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 79 - ] - }, - { - "title": "Properties", - "children": [ - 81 - ] - } - ] - }, - { - "id": 1507, - "name": "AdminPostPublishableApiKeySalesChannelsBatchReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the sales channels to add to the publishable API key." - } - ] - }, - "children": [ - { - "id": 1508, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1509, - "name": "new AdminPostPublishableApiKeySalesChannelsBatchReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the sales channels to add to the publishable API key." - } - ] - }, - "type": { - "type": "reference", - "target": 1507, - "name": "AdminPostPublishableApiKeySalesChannelsBatchReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1510, - "name": "sales_channel_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the sales channels to add to the publishable API key" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4680, - "name": "ProductBatchSalesChannel", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1508 - ] - }, - { - "title": "Properties", - "children": [ - 1510 - ] - } - ] - }, - { - "id": 1532, - "name": "AdminPostPublishableApiKeysPublishableApiKeyReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the publishable API key." - } - ] - }, - "children": [ - { - "id": 1533, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1534, - "name": "new AdminPostPublishableApiKeysPublishableApiKeyReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the publishable API key." - } - ] - }, - "type": { - "type": "reference", - "target": 1532, - "name": "AdminPostPublishableApiKeysPublishableApiKeyReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1535, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Publishable API Key." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1533 - ] - }, - { - "title": "Properties", - "children": [ - 1535 - ] - } - ] - }, - { - "id": 1511, - "name": "AdminPostPublishableApiKeysReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the publishable API key to create." - } - ] - }, - "children": [ - { - "id": 1512, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1513, - "name": "new AdminPostPublishableApiKeysReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the publishable API key to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1511, - "name": "AdminPostPublishableApiKeysReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1514, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the publishable API key" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1512 - ] - }, - { - "title": "Properties", - "children": [ - 1514 - ] - } - ] - }, - { - "id": 1554, - "name": "AdminPostRegionsRegionCountriesReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the country to add to the region." - } - ] - }, - "children": [ - { - "id": 1555, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1556, - "name": "new AdminPostRegionsRegionCountriesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the country to add to the region." - } - ] - }, - "type": { - "type": "reference", - "target": 1554, - "name": "AdminPostRegionsRegionCountriesReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1557, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The 2 character ISO code for the Country." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1555 - ] - }, - { - "title": "Properties", - "children": [ - 1557 - ] - } - ] - }, - { - "id": 1558, - "name": "AdminPostRegionsRegionFulfillmentProvidersReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the fulfillment provider to add to the region." - } - ] - }, - "children": [ - { - "id": 1559, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1560, - "name": "new AdminPostRegionsRegionFulfillmentProvidersReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the fulfillment provider to add to the region." - } - ] - }, - "type": { - "type": "reference", - "target": 1558, - "name": "AdminPostRegionsRegionFulfillmentProvidersReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1561, - "name": "provider_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Fulfillment Provider." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1559 - ] - }, - { - "title": "Properties", - "children": [ - 1561 - ] - } - ] - }, - { - "id": 1562, - "name": "AdminPostRegionsRegionPaymentProvidersReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the payment provider to add to the region." - } - ] - }, - "children": [ - { - "id": 1563, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1564, - "name": "new AdminPostRegionsRegionPaymentProvidersReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the payment provider to add to the region." - } - ] - }, - "type": { - "type": "reference", - "target": 1562, - "name": "AdminPostRegionsRegionPaymentProvidersReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1565, - "name": "provider_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Payment Provider." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1563 - ] - }, - { - "title": "Properties", - "children": [ - 1565 - ] - } - ] - }, - { - "id": 1589, - "name": "AdminPostRegionsRegionReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the regions." - } - ] - }, - "children": [ - { - "id": 1590, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1591, - "name": "new AdminPostRegionsRegionReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the regions." - } - ] - }, - "type": { - "type": "reference", - "target": 1589, - "name": "AdminPostRegionsRegionReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1597, - "name": "automatic_taxes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, the Medusa backend will automatically calculate taxes for carts in this region. If set to `false`, the taxes must be calculated manually." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1601, - "name": "countries", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of countries' 2 ISO characters that should be included in the Region." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1593, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The 3 character ISO currency code to use in the Region." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1600, - "name": "fulfillment_providers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of Fulfillment Provider IDs that can be used in the Region" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1596, - "name": "gift_cards_taxable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, taxes will be applied on gift cards." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1602, - "name": "includes_tax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether taxes are included in the prices of the region." - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "tax_inclusive_pricing", - "tag": "@featureFlag" - } - ] - }, - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "tax_inclusive_pricing", - "tag": "@featureFlag" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1603, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1592, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Region" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1599, - "name": "payment_providers", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of Payment Provider IDs that can be used in the Region" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1594, - "name": "tax_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax code of the Region." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1598, - "name": "tax_provider_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the tax provider to use. If none provided, the system tax provider is used." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1595, - "name": "tax_rate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax rate to use in the Region." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1590 - ] - }, - { - "title": "Properties", - "children": [ - 1597, - 1601, - 1593, - 1600, - 1596, - 1602, - 1603, - 1592, - 1599, - 1594, - 1598, - 1595 - ] - } - ] - }, - { - "id": 1566, - "name": "AdminPostRegionsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the region to create." - } - ] - }, - "children": [ - { - "id": 1567, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1568, - "name": "new AdminPostRegionsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the region to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1566, - "name": "AdminPostRegionsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1575, - "name": "countries", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of countries' 2 ISO characters that should be included in the Region." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1570, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The 3 character ISO currency code to use in the Region." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1574, - "name": "fulfillment_providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of Fulfillment Provider IDs that can be used in the Region" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1576, - "name": "includes_tax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether taxes are included in the prices of the region." - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "tax_inclusive_pricing", - "tag": "@featureFlag" - } - ] - }, - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "tax_inclusive_pricing", - "tag": "@featureFlag" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1577, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1569, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Region" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1573, - "name": "payment_providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of Payment Provider IDs that can be used in the Region" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1571, - "name": "tax_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax code of the Region." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1572, - "name": "tax_rate", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax rate to use in the Region." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1567 - ] - }, - { - "title": "Properties", - "children": [ - 1575, - 1570, - 1574, - 1576, - 1577, - 1569, - 1573, - 1571, - 1572 - ] - } - ] - }, - { - "id": 1665, - "name": "AdminPostReservationsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the reservation to create." - } - ] - }, - "children": [ - { - "id": 1666, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1667, - "name": "new AdminPostReservationsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the reservation to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1665, - "name": "AdminPostReservationsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1672, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The reservation's description." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1670, - "name": "inventory_item_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the inventory item the reservation is associated with." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1668, - "name": "line_item_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the line item of the reservation." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1669, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the location of the reservation." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1673, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1671, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity to reserve." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1666 - ] - }, - { - "title": "Properties", - "children": [ - 1672, - 1670, - 1668, - 1669, - 1673, - 1671 - ] - } - ] - }, - { - "id": 1689, - "name": "AdminPostReservationsReservationReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the reservation." - } - ] - }, - "children": [ - { - "id": 1690, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1691, - "name": "new AdminPostReservationsReservationReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the reservation." - } - ] - }, - "type": { - "type": "reference", - "target": 1689, - "name": "AdminPostReservationsReservationReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1694, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The reservation's description." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1693, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the location associated with the reservation." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1695, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1692, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity to reserve." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1690 - ] - }, - { - "title": "Properties", - "children": [ - 1694, - 1693, - 1695, - 1692 - ] - } - ] - }, - { - "id": 1621, - "name": "AdminPostReturnReasonsReasonReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the return reason." - } - ] - }, - "children": [ - { - "id": 1622, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1623, - "name": "new AdminPostReturnReasonsReasonReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the return reason." - } - ] - }, - "type": { - "type": "reference", - "target": 1621, - "name": "AdminPostReturnReasonsReasonReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1626, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the Reason." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1624, - "name": "label", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The label to display to the Customer." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1627, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1625, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique value of the return reason." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1622 - ] - }, - { - "title": "Properties", - "children": [ - 1626, - 1624, - 1627, - 1625 - ] - } - ] - }, - { - "id": 1613, - "name": "AdminPostReturnReasonsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the return reason to create." - } - ] - }, - "children": [ - { - "id": 1614, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1615, - "name": "new AdminPostReturnReasonsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the return reason to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1613, - "name": "AdminPostReturnReasonsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1619, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the Reason." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1617, - "name": "label", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The label to display to the Customer." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1620, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1618, - "name": "parent_return_reason_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the parent return reason." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1616, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A unique value of the return reason." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1614 - ] - }, - { - "title": "Properties", - "children": [ - 1619, - 1617, - 1620, - 1618, - 1616 - ] - } - ] - }, - { - "id": 1646, - "name": "AdminPostReturnsReturnReceiveReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the received return." - } - ] - }, - "children": [ - { - "id": 1647, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1648, - "name": "new AdminPostReturnsReturnReceiveReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the received return." - } - ] - }, - "type": { - "type": "reference", - "target": 1646, - "name": "AdminPostReturnsReturnReceiveReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1649, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Line Items that have been received." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4684, - "name": "Item", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 1651, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the location to return items from." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1650, - "name": "refund", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount to refund." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1647 - ] - }, - { - "title": "Properties", - "children": [ - 1649, - 1651, - 1650 - ] - } - ] - }, - { - "id": 1704, - "name": "AdminPostSalesChannelsChannelProductsBatchReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to add to the sales channel." - } - ] - }, - "children": [ - { - "id": 1705, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1706, - "name": "new AdminPostSalesChannelsChannelProductsBatchReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to add to the sales channel." - } - ] - }, - "type": { - "type": "reference", - "target": 1704, - "name": "AdminPostSalesChannelsChannelProductsBatchReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1707, - "name": "product_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the products to add to the sales channel" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4680, - "name": "ProductBatchSalesChannel", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1705 - ] - }, - { - "title": "Properties", - "children": [ - 1707 - ] - } - ] - }, - { - "id": 1740, - "name": "AdminPostSalesChannelsChannelStockLocationsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1741, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1742, - "name": "new AdminPostSalesChannelsChannelStockLocationsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1740, - "name": "AdminPostSalesChannelsChannelStockLocationsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1743, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the stock location" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1741 - ] - }, - { - "title": "Properties", - "children": [ - 1743 - ] - } - ] - }, - { - "id": 1708, - "name": "AdminPostSalesChannelsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the sales channel to create." - } - ] - }, - "children": [ - { - "id": 1709, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1710, - "name": "new AdminPostSalesChannelsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the sales channel to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1708, - "name": "AdminPostSalesChannelsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1712, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the Sales Channel" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1713, - "name": "is_disabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Sales Channel is disabled." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1711, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Sales Channel" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1709 - ] - }, - { - "title": "Properties", - "children": [ - 1712, - 1713, - 1711 - ] - } - ] - }, - { - "id": 1734, - "name": "AdminPostSalesChannelsSalesChannelReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the sales channel." - } - ] - }, - "children": [ - { - "id": 1735, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1736, - "name": "new AdminPostSalesChannelsSalesChannelReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the sales channel." - } - ] - }, - "type": { - "type": "reference", - "target": 1734, - "name": "AdminPostSalesChannelsSalesChannelReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1738, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the sales channel." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1739, - "name": "is_disabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Sales Channel is disabled." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1737, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the sales channel" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1735 - ] - }, - { - "title": "Properties", - "children": [ - 1738, - 1739, - 1737 - ] - } - ] - }, - { - "id": 1777, - "name": "AdminPostShippingOptionsOptionReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the shipping option." - } - ] - }, - "children": [ - { - "id": 1778, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1779, - "name": "new AdminPostShippingOptionsOptionReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the shipping option." - } - ] - }, - "type": { - "type": "reference", - "target": 1777, - "name": "AdminPostShippingOptionsOptionReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1784, - "name": "admin_only", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, the shipping option can only be used when creating draft orders." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1781, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount to charge for the Shipping Option. If the `price_type` of the shipping option is `calculated`, this amount will not actually be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1786, - "name": "includes_tax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tax included in prices of shipping option" - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "tax_inclusive_pricing", - "tag": "@featureFlag" - } - ] - }, - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "tax_inclusive_pricing", - "tag": "@featureFlag" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1785, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1780, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Shipping Option" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1782, - "name": "price_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", - "qualifiedName": "ShippingOptionPriceType" - }, - "name": "ShippingOptionPriceType", - "package": "@medusajs/medusa" - } - }, - { - "id": 1783, - "name": "requirements", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The requirements that must be satisfied for the Shipping Option to be available." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4707, - "name": "OptionRequirement", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1778 - ] - }, - { - "title": "Properties", - "children": [ - 1784, - 1781, - 1786, - 1785, - 1780, - 1782, - 1783 - ] - } - ] - }, - { - "id": 1756, - "name": "AdminPostShippingOptionsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the shipping option to create." - } - ] - }, - "children": [ - { - "id": 1757, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1758, - "name": "new AdminPostShippingOptionsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the shipping option to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1756, - "name": "AdminPostShippingOptionsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1767, - "name": "admin_only", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If set to `true`, the shipping option can only be used when creating draft orders." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 1765, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount to charge for the Shipping Option. If the `price_type` is set to `calculated`, this amount will not actually be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1763, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data needed for the Fulfillment Provider to handle shipping with this Shipping Option." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1770, - "name": "includes_tax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tax included in prices of shipping option" - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "tax_inclusive_pricing", - "tag": "@featureFlag" - } - ] - }, - { - "tag": "@featureFlag", - "content": [ - { - "kind": "inline-tag", - "text": "tax_inclusive_pricing", - "tag": "@featureFlag" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1768, - "name": "is_return", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Shipping Option can be used for returns or during checkout." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" - }, - { - "id": 1769, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1759, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Shipping Option" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1764, - "name": "price_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the Shipping Option price. `flat_rate` indicates fixed pricing, whereas `calculated` indicates that the price will be calculated each time by the fulfillment provider." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", - "qualifiedName": "ShippingOptionPriceType" - }, - "name": "ShippingOptionPriceType", - "package": "@medusajs/medusa" - } - }, - { - "id": 1762, - "name": "profile_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Shipping Profile to add the Shipping Option to." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1761, - "name": "provider_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Fulfillment Provider that handles the Shipping Option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1760, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Region in which the Shipping Option will be available." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1766, - "name": "requirements", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The requirements that must be satisfied for the Shipping Option to be available." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4702, - "name": "OptionRequirement", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1757 - ] - }, - { - "title": "Properties", - "children": [ - 1767, - 1765, - 1763, - 1770, - 1768, - 1769, - 1759, - 1764, - 1762, - 1761, - 1760, - 1766 - ] - } - ] - }, - { - "id": 1802, - "name": "AdminPostShippingProfilesProfileReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The detail to update of the shipping profile." - } - ] - }, - "children": [ - { - "id": 1803, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1804, - "name": "new AdminPostShippingProfilesProfileReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The detail to update of the shipping profile." - } - ] - }, - "type": { - "type": "reference", - "target": 1802, - "name": "AdminPostShippingProfilesProfileReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1806, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1805, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Shipping Profile" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1808, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "product IDs to associate with the Shipping Profile" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1809, - "name": "shipping_options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Shipping option IDs to associate with the Shipping Profile" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1807, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the Shipping Profile" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", - "qualifiedName": "ShippingProfileType" - }, - "name": "ShippingProfileType", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1803 - ] - }, - { - "title": "Properties", - "children": [ - 1806, - 1805, - 1808, - 1809, - 1807 - ] - } - ] - }, - { - "id": 1796, - "name": "AdminPostShippingProfilesReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the shipping profile to create." - } - ] - }, - "children": [ - { - "id": 1797, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1798, - "name": "new AdminPostShippingProfilesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the shipping profile to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1796, - "name": "AdminPostShippingProfilesReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1801, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1799, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Shipping Profile" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1800, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the Shipping Profile" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", - "qualifiedName": "ShippingProfileType" - }, - "name": "ShippingProfileType", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1797 - ] - }, - { - "title": "Properties", - "children": [ - 1801, - 1799, - 1800 - ] - } - ] - }, - { - "id": 1855, - "name": "AdminPostStockLocationsLocationParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1856, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1857, - "name": "new AdminPostStockLocationsLocationParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1855, - "name": "AdminPostStockLocationsLocationParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 1858, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 1859, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1856 - ] - }, - { - "title": "Properties", - "children": [ - 1858, - 1859 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1848, - "name": "AdminPostStockLocationsLocationReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the stock location." - } - ] - }, - "children": [ - { - "id": 1849, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1850, - "name": "new AdminPostStockLocationsLocationReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the stock location." - } - ] - }, - "type": { - "type": "reference", - "target": 1848, - "name": "AdminPostStockLocationsLocationReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1852, - "name": "address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data of an associated address to create or update." - } - ] - }, - "type": { - "type": "reference", - "target": 4742, - "name": "StockLocationAddress", - "package": "@medusajs/medusa" - } - }, - { - "id": 1853, - "name": "address_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the stock location address ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1854, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional key-value map with additional details" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1851, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the name of the stock location" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1849 - ] - }, - { - "title": "Properties", - "children": [ - 1852, - 1853, - 1854, - 1851 - ] - } - ] - }, - { - "id": 1826, - "name": "AdminPostStockLocationsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1827, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1828, - "name": "new AdminPostStockLocationsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1826, - "name": "AdminPostStockLocationsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 1829, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 1830, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1827 - ] - }, - { - "title": "Properties", - "children": [ - 1829, - 1830 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1819, - "name": "AdminPostStockLocationsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the stock location to create." - } - ] - }, - "children": [ - { - "id": 1820, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1821, - "name": "new AdminPostStockLocationsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the stock location to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1819, - "name": "AdminPostStockLocationsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1823, - "name": "address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A new stock location address to create and associate with the stock location. Only required if `address_id` is not provided." - } - ] - }, - "type": { - "type": "reference", - "target": 4731, - "name": "StockLocationAddress", - "package": "@medusajs/medusa" - } - }, - { - "id": 1824, - "name": "address_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the ID of an existing stock location address to associate with the stock location. Only required if `address` is not provided." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1825, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional key-value map with additional details" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1822, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the name of the stock location" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1820 - ] - }, - { - "title": "Properties", - "children": [ - 1823, - 1824, - 1825, - 1822 - ] - } - ] - }, - { - "id": 1873, - "name": "AdminPostStoreReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the store." - } - ] - }, - "children": [ - { - "id": 1874, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1875, - "name": "new AdminPostStoreReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the store." - } - ] - }, - "type": { - "type": "reference", - "target": 1873, - "name": "AdminPostStoreReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1881, - "name": "currencies", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of available currencies in the store. Each currency is in 3 character ISO code format." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1880, - "name": "default_currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The default currency code of the Store." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1879, - "name": "invite_link_template", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A template for invite links - use `{{invite_token}}` to insert the invite token" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1882, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1876, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the Store" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1878, - "name": "payment_link_template", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A template for payment links - use `{{cart_id}}` to insert the Cart ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1877, - "name": "swap_link_template", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A template for Swap links - use `{{cart_id}}` to insert the Swap Cart ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1874 - ] - }, - { - "title": "Properties", - "children": [ - 1881, - 1880, - 1879, - 1882, - 1876, - 1878, - 1877 - ] - } - ] - }, - { - "id": 1985, - "name": "AdminPostTaxRatesParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1986, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1987, - "name": "new AdminPostTaxRatesParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1985, - "name": "AdminPostTaxRatesParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1988, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1989, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1986 - ] - }, - { - "title": "Properties", - "children": [ - 1988, - 1989 - ] - } - ] - }, - { - "id": 1975, - "name": "AdminPostTaxRatesReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the tax rate to create." - } - ] - }, - "children": [ - { - "id": 1976, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1977, - "name": "new AdminPostTaxRatesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the tax rate to create." - } - ] - }, - "type": { - "type": "reference", - "target": 1975, - "name": "AdminPostTaxRatesReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1978, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The code of the tax rate." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1979, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the tax rate." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1984, - "name": "product_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the types of products associated with this tax rate" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1982, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the products associated with this tax rate." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1981, - "name": "rate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The numeric rate to charge." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1980, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Region that the tax rate belongs to." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1983, - "name": "shipping_options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the shipping options associated with this tax rate" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1976 - ] - }, - { - "title": "Properties", - "children": [ - 1978, - 1979, - 1984, - 1982, - 1981, - 1980, - 1983 - ] - } - ] - }, - { - "id": 2000, - "name": "AdminPostTaxRatesTaxRateParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 2001, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2002, - "name": "new AdminPostTaxRatesTaxRateParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2000, - "name": "AdminPostTaxRatesTaxRateParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2003, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2004, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2001 - ] - }, - { - "title": "Properties", - "children": [ - 2003, - 2004 - ] - } - ] - }, - { - "id": 1952, - "name": "AdminPostTaxRatesTaxRateProductTypesParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1953, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1954, - "name": "new AdminPostTaxRatesTaxRateProductTypesParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1952, - "name": "AdminPostTaxRatesTaxRateProductTypesParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1955, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1956, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1953 - ] - }, - { - "title": "Properties", - "children": [ - 1955, - 1956 - ] - } - ] - }, - { - "id": 1948, - "name": "AdminPostTaxRatesTaxRateProductTypesReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product types to add to the tax rate." - } - ] - }, - "children": [ - { - "id": 1949, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1950, - "name": "new AdminPostTaxRatesTaxRateProductTypesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product types to add to the tax rate." - } - ] - }, - "type": { - "type": "reference", - "target": 1948, - "name": "AdminPostTaxRatesTaxRateProductTypesReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1951, - "name": "product_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the types of products to associate with this tax rate" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1949 - ] - }, - { - "title": "Properties", - "children": [ - 1951 - ] - } - ] - }, - { - "id": 1961, - "name": "AdminPostTaxRatesTaxRateProductsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1962, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1963, - "name": "new AdminPostTaxRatesTaxRateProductsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1961, - "name": "AdminPostTaxRatesTaxRateProductsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1964, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1965, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1962 - ] - }, - { - "title": "Properties", - "children": [ - 1964, - 1965 - ] - } - ] - }, - { - "id": 1957, - "name": "AdminPostTaxRatesTaxRateProductsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to associat with the tax rate." - } - ] - }, - "children": [ - { - "id": 1958, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1959, - "name": "new AdminPostTaxRatesTaxRateProductsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the products to associat with the tax rate." - } - ] - }, - "type": { - "type": "reference", - "target": 1957, - "name": "AdminPostTaxRatesTaxRateProductsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1960, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the products to associate with this tax rate" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1958 - ] - }, - { - "title": "Properties", - "children": [ - 1960 - ] - } - ] - }, - { - "id": 1990, - "name": "AdminPostTaxRatesTaxRateReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the tax rate." - } - ] - }, - "children": [ - { - "id": 1991, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1992, - "name": "new AdminPostTaxRatesTaxRateReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the tax rate." - } - ] - }, - "type": { - "type": "reference", - "target": 1990, - "name": "AdminPostTaxRatesTaxRateReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1993, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The code of the tax rate." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1994, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the tax rate." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1999, - "name": "product_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the types of product types associated with this tax rate" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1997, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the products associated with this tax rate" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1996, - "name": "rate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The numeric rate to charge." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1995, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Region that the tax rate belongs to." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1998, - "name": "shipping_options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the shipping options associated with this tax rate" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1991 - ] - }, - { - "title": "Properties", - "children": [ - 1993, - 1994, - 1999, - 1997, - 1996, - 1995, - 1998 - ] - } - ] - }, - { - "id": 1970, - "name": "AdminPostTaxRatesTaxRateShippingOptionsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1971, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1972, - "name": "new AdminPostTaxRatesTaxRateShippingOptionsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1970, - "name": "AdminPostTaxRatesTaxRateShippingOptionsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1973, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1974, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1971 - ] - }, - { - "title": "Properties", - "children": [ - 1973, - 1974 - ] - } - ] - }, - { - "id": 1966, - "name": "AdminPostTaxRatesTaxRateShippingOptionsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the shipping options to associate with the tax rate." - } - ] - }, - "children": [ - { - "id": 1967, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1968, - "name": "new AdminPostTaxRatesTaxRateShippingOptionsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the shipping options to associate with the tax rate." - } - ] - }, - "type": { - "type": "reference", - "target": 1966, - "name": "AdminPostTaxRatesTaxRateShippingOptionsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1969, - "name": "shipping_options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the shipping options to associate with this tax rate" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1967 - ] - }, - { - "title": "Properties", - "children": [ - 1969 - ] - } - ] - }, - { - "id": 2021, - "name": "AdminPostUploadsDownloadUrlReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the file to retrieve its download URL." - } - ] - }, - "children": [ - { - "id": 2022, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2023, - "name": "new AdminPostUploadsDownloadUrlReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the file to retrieve its download URL." - } - ] - }, - "type": { - "type": "reference", - "target": 2021, - "name": "AdminPostUploadsDownloadUrlReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2024, - "name": "file_key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "key of the file to obtain the download link for. This is obtained when you first uploaded the file, or by the file service if you used it directly." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2022 - ] - }, - { - "title": "Properties", - "children": [ - 2024 - ] - } - ] - }, - { - "id": 4090, - "name": "AdminPriceListPricesCreateReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4091, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4092, - "name": "new AdminPriceListPricesCreateReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4090, - "name": "AdminPriceListPricesCreateReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4095, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount to charge for the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4094, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The 3 character ISO currency code for which the price will be used. This is only required if `region_id` is not provided." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4098, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum quantity for which the price will be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4097, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The minimum quantity for which the price will be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4093, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Region for which the price is used. This is only required if `currecny_code` is not provided." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4096, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Variant for which the price is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4091 - ] - }, - { - "title": "Properties", - "children": [ - 4095, - 4094, - 4098, - 4097, - 4093, - 4096 - ] - } - ] - }, - { - "id": 4080, - "name": "AdminPriceListPricesUpdateReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4081, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4082, - "name": "new AdminPriceListPricesUpdateReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4080, - "name": "AdminPriceListPricesUpdateReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4087, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount to charge for the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4085, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The 3 character ISO currency code for which the price will be used. This is only required if `region_id` is not provided." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4083, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the price." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4089, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum quantity for which the price will be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4088, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The minimum quantity for which the price will be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4084, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Region for which the price is used. This is only required if `currecny_code` is not provided." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4086, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Variant for which the price is used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4081 - ] - }, - { - "title": "Properties", - "children": [ - 4087, - 4085, - 4083, - 4089, - 4088, - 4084, - 4086 - ] - } - ] - }, - { - "id": 4764, - "name": "AdminPriceSelectionParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The context to apply on retrieved prices by a user admin." - } - ] - }, - "children": [ - { - "id": 4765, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4766, - "name": "new AdminPriceSelectionParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4764, - "name": "AdminPriceSelectionParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4783, - "name": "PriceSelectionParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4782, - "name": "PriceSelectionParams.constructor" - } - }, - { - "id": 4768, - "name": "cart_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a cart ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4784, - "name": "PriceSelectionParams.cart_id" - } - }, - { - "id": 4770, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a currency code." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4786, - "name": "PriceSelectionParams.currency_code" - } - }, - { - "id": 4767, - "name": "customer_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a customer ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4771, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4787, - "name": "PriceSelectionParams.expand" - } - }, - { - "id": 4772, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4788, - "name": "PriceSelectionParams.fields" - } - }, - { - "id": 4769, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a region ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4785, - "name": "PriceSelectionParams.region_id" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4765 - ] - }, - { - "title": "Properties", - "children": [ - 4768, - 4770, - 4767, - 4771, - 4772, - 4769 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4781, - "name": "PriceSelectionParams", - "package": "@medusajs/medusa" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2074, - "name": "AdminGetVariantsParams" - } - ] - }, - { - "id": 4550, - "name": "AdminProductCategoriesReqBase", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4551, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4552, - "name": "new AdminProductCategoriesReqBase", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4550, - "name": "AdminProductCategoriesReqBase", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4553, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4554, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4556, - "name": "is_active", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4555, - "name": "is_internal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4557, - "name": "parent_category_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4551 - ] - }, - { - "title": "Properties", - "children": [ - 4553, - 4554, - 4556, - 4555, - 4557 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1187, - "name": "AdminPostProductCategoriesReq" - }, - { - "type": "reference", - "target": 1202, - "name": "AdminPostProductCategoriesCategoryReq" - } - ] - }, - { - "id": 2040, - "name": "AdminResetPasswordRequest", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the password reset request." - } - ] - }, - "children": [ - { - "id": 2041, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2042, - "name": "new AdminResetPasswordRequest", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the password reset request." - } - ] - }, - "type": { - "type": "reference", - "target": 2040, - "name": "AdminResetPasswordRequest", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2043, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The User's email." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2045, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The User's new password." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2044, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The password-reset token generated when the password reset was requested." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2041 - ] - }, - { - "title": "Properties", - "children": [ - 2043, - 2045, - 2044 - ] - } - ] - }, - { - "id": 2046, - "name": "AdminResetPasswordTokenRequest", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the password reset token request." - } - ] - }, - "children": [ - { - "id": 2047, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2048, - "name": "new AdminResetPasswordTokenRequest", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the password reset token request." - } - ] - }, - "type": { - "type": "reference", - "target": 2046, - "name": "AdminResetPasswordTokenRequest", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2049, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The User's email." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2047 - ] - }, - { - "title": "Properties", - "children": [ - 2049 - ] - } - ] - }, - { - "id": 341, - "name": "AdminUpdateDiscountRule", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attributes of the discount rule to update." - } - ] - }, - "children": [ - { - "id": 342, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 343, - "name": "new AdminUpdateDiscountRule", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 341, - "name": "AdminUpdateDiscountRule", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 347, - "name": "allocation", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The discount rule's allocation." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/discount-rule.ts", - "qualifiedName": "AllocationType" - }, - "name": "AllocationType", - "package": "@medusajs/medusa" - } - }, - { - "id": 348, - "name": "conditions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The discount rule's discount conditions." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 349, - "name": "AdminUpsertCondition", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 345, + "id": 259, "name": "description", "variant": "declaration", "kind": 1024, @@ -55108,8 +8387,8 @@ } }, { - "id": 344, - "name": "id", + "id": 260, + "name": "type", "variant": "declaration", "kind": 1024, "flags": {}, @@ -55117,23 +8396,26 @@ "summary": [ { "kind": "text", - "text": "The discount rule's ID." + "text": "The discount rule's type." } ] }, "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/discount-rule.ts", + "qualifiedName": "DiscountRuleType" + }, + "name": "DiscountRuleType", + "package": "@medusajs/medusa" } }, { - "id": 346, + "id": 261, "name": "value", "variant": "declaration", "kind": 1024, - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { "summary": [ { @@ -55146,370 +8428,34 @@ "type": "intrinsic", "name": "number" } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 342 - ] }, { - "title": "Properties", - "children": [ - 347, - 348, - 345, - 344, - 346 - ] - } - ] - }, - { - "id": 1011, - "name": "AdminUpdatePaymentCollectionsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the payment collection." - } - ] - }, - "children": [ - { - "id": 1012, - "name": "constructor", + "id": 262, + "name": "allocation", "variant": "declaration", - "kind": 512, + "kind": 1024, "flags": {}, - "signatures": [ - { - "id": 1013, - "name": "new AdminUpdatePaymentCollectionsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the payment collection." - } - ] - }, - "type": { - "type": "reference", - "target": 1011, - "name": "AdminUpdatePaymentCollectionsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1014, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, "comment": { "summary": [ { "kind": "text", - "text": "A description to create or update the payment collection." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1015, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A set of key-value pairs to hold additional information." + "text": "The discount rule's allocation." } ] }, "type": { "type": "reference", "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" + "sourceFileName": "../../../packages/medusa/src/models/discount-rule.ts", + "qualifiedName": "AllocationType" }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1012 - ] - }, - { - "title": "Properties", - "children": [ - 1014, - 1015 - ] - } - ] - }, - { - "id": 2058, - "name": "AdminUpdateUserRequest", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2059, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2060, - "name": "new AdminUpdateUserRequest", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2058, - "name": "AdminUpdateUserRequest", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2064, - "name": "api_token", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The API token of the User." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2061, - "name": "first_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The first name of the User." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2062, - "name": "last_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The last name of the User." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2065, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2063, - "name": "role", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The role assigned to the user. These roles don't provide any different privileges." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/user.ts", - "qualifiedName": "UserRoles" - }, - "name": "UserRoles", + "name": "AllocationType", "package": "@medusajs/medusa" } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2059 - ] }, { - "title": "Properties", - "children": [ - 2064, - 2061, - 2062, - 2065, - 2063 - ] - } - ] - }, - { - "id": 349, - "name": "AdminUpsertCondition", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attributes to create or update in the discount condition." - } - ] - }, - "children": [ - { - "id": 350, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 351, - "name": "new AdminUpsertCondition", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 349, - "name": "AdminUpsertCondition", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4353, - "name": "AdminUpsertConditionsReq.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4352, - "name": "AdminUpsertConditionsReq.constructor" - } - }, - { - "id": 358, - "name": "customer_groups", + "id": 263, + "name": "conditions", "variant": "declaration", "kind": 1024, "flags": { @@ -55519,54 +8465,89 @@ "summary": [ { "kind": "text", - "text": "The customer groups associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`customer_groups`" - }, - { - "kind": "text", - "text": "." + "text": "The discount rule's conditions." } ] }, "type": { "type": "array", "elementType": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": 264, + "name": "AdminCreateCondition", + "package": "@medusajs/medusa" } - }, + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 257 + ] + }, + { + "title": "Properties", + "children": [ + 259, + 260, + 261, + 262, + 263 + ] + } + ] + }, + { + "id": 264, + "name": "AdminCreateCondition", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Details of the discount condition to create." + } + ] + }, + "children": [ + { + "id": 265, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 266, + "name": "new AdminCreateCondition", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 264, + "name": "AdminCreateCondition", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4360, + "name": "AdminUpsertConditionsReq.constructor" + } + } + ], "inheritedFrom": { "type": "reference", - "target": 4358, - "name": "AdminUpsertConditionsReq.customer_groups" + "target": 4359, + "name": "AdminUpsertConditionsReq.constructor" } }, { - "id": 352, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The discount condition's ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 353, + "id": 267, "name": "operator", "variant": "declaration", "kind": 1024, @@ -55575,7 +8556,7 @@ "summary": [ { "kind": "text", - "text": "The discount condition's operator." + "text": "The operator of the discount condition." } ] }, @@ -55590,118 +8571,7 @@ } }, { - "id": 355, - "name": "product_collections", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product collections associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_collections`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4355, - "name": "AdminUpsertConditionsReq.product_collections" - } - }, - { - "id": 357, - "name": "product_tags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product tags associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_tags`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4357, - "name": "AdminUpsertConditionsReq.product_tags" - } - }, - { - "id": 356, - "name": "product_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product types associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_types`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 4356, - "name": "AdminUpsertConditionsReq.product_types" - } - }, - { - "id": 354, + "id": 268, "name": "products", "variant": "declaration", "kind": 1024, @@ -55733,79 +8603,123 @@ }, "inheritedFrom": { "type": "reference", - "target": 4354, + "target": 4361, "name": "AdminUpsertConditionsReq.products" } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 350 - ] }, { - "title": "Properties", - "children": [ - 358, - 352, - 353, - 355, - 357, - 356, - 354 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4351, - "name": "AdminUpsertConditionsReq", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 4351, - "name": "AdminUpsertConditionsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields to create or update a discount condition." - } - ] - }, - "children": [ - { - "id": 4352, - "name": "constructor", + "id": 269, + "name": "product_collections", "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4353, - "name": "new AdminUpsertConditionsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4351, - "name": "AdminUpsertConditionsReq", - "package": "@medusajs/medusa" + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collections associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_collections`" + }, + { + "kind": "text", + "text": "." } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" } - ] + }, + "inheritedFrom": { + "type": "reference", + "target": 4362, + "name": "AdminUpsertConditionsReq.product_collections" + } }, { - "id": 4358, + "id": 270, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product types associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_types`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4363, + "name": "AdminUpsertConditionsReq.product_types" + } + }, + { + "id": 271, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product tags associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_tags`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4364, + "name": "AdminUpsertConditionsReq.product_tags" + } + }, + { + "id": 272, "name": "customer_groups", "variant": "declaration", "kind": 1024, @@ -55834,134 +8748,11 @@ "type": "intrinsic", "name": "string" } - } - }, - { - "id": 4355, - "name": "product_collections", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product collections associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_collections`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4357, - "name": "product_tags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product tags associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_tags`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4356, - "name": "product_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product types associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`product_types`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4354, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The products associated with the discount condition, if the discount condition's type is " - }, - { - "kind": "code", - "text": "`products`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } + "inheritedFrom": { + "type": "reference", + "target": 4365, + "name": "AdminUpsertConditionsReq.customer_groups" } } ], @@ -55969,2203 +8760,33 @@ { "title": "Constructors", "children": [ - 4352 + 265 ] }, { "title": "Properties", "children": [ - 4358, - 4355, - 4357, - 4356, - 4354 + 267, + 268, + 269, + 270, + 271, + 272 ] } ], - "extendedBy": [ + "extendedTypes": [ { "type": "reference", - "target": 229, - "name": "AdminPostDiscountsDiscountConditions" - }, - { - "type": "reference", - "target": 264, - "name": "AdminCreateCondition" - }, - { - "type": "reference", - "target": 316, - "name": "AdminPostDiscountsDiscountConditionsCondition" - }, - { - "type": "reference", - "target": 349, - "name": "AdminUpsertCondition" + "target": 4358, + "name": "AdminUpsertConditionsReq", + "package": "@medusajs/medusa" } ] }, { - "id": 4471, - "name": "CustomShippingOption", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom Shipping Options are overridden Shipping Options. Admins can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option." - } - ] - }, - "children": [ - { - "id": 4472, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4473, - "name": "new CustomShippingOption", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Custom Shipping Options are overridden Shipping Options. Admins can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option." - } - ] - }, - "type": { - "type": "reference", - "target": 4471, - "name": "CustomShippingOption", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4474, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Shipping Option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4475, - "name": "price", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The custom price of the Shipping Option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4472 - ] - }, - { - "title": "Properties", - "children": [ - 4474, - 4475 - ] - } - ] - }, - { - "id": 4542, - "name": "CustomerGroup", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A customer group that can be used to organize customers into groups of similar traits." - } - ] - }, - "children": [ - { - "id": 4543, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4544, - "name": "new CustomerGroup", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A customer group that can be used to organize customers into groups of similar traits." - } - ] - }, - "type": { - "type": "reference", - "target": 4542, - "name": "CustomerGroup", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4545, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a customer group" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4543 - ] - }, - { - "title": "Properties", - "children": [ - 4545 - ] - } - ] - }, - { - "id": 4546, - "name": "CustomerGroup", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A customer group that can be used to organize customers into groups of similar traits." - } - ] - }, - "children": [ - { - "id": 4547, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4548, - "name": "new CustomerGroup", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A customer group that can be used to organize customers into groups of similar traits." - } - ] - }, - "type": { - "type": "reference", - "target": 4546, - "name": "CustomerGroup", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4549, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a customer group" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4547 - ] - }, - { - "title": "Properties", - "children": [ - 4549 - ] - } - ] - }, - { - "id": 4328, - "name": "CustomerGroupsBatchCustomer", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4329, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4330, - "name": "new CustomerGroupsBatchCustomer", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4328, - "name": "CustomerGroupsBatchCustomer", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4331, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the customer" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4329 - ] - }, - { - "title": "Properties", - "children": [ - 4331 - ] - } - ] - }, - { - "id": 3911, - "name": "DateComparisonOperator", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields used to apply flexible filters on dates." - } - ] - }, - "children": [ - { - "id": 3912, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 3913, - "name": "new DateComparisonOperator", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 3915, - "name": "gt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered date must be greater than this value." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 3916, - "name": "gte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered date must be greater than or equal to this value." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 3914, - "name": "lt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered date must be less than this value." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 3917, - "name": "lte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered date must be less than or equal to this value." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3912 - ] - }, - { - "title": "Properties", - "children": [ - 3915, - 3916, - 3914, - 3917 - ] - } - ] - }, - { - "id": 4372, - "name": "Discount", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A discount can be applied to a cart for promotional purposes." - } - ] - }, - "children": [ - { - "id": 4373, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4374, - "name": "new Discount", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A discount can be applied to a cart for promotional purposes." - } - ] - }, - "type": { - "type": "reference", - "target": 4372, - "name": "Discount", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4375, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The code of the discount to apply" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4373 - ] - }, - { - "title": "Properties", - "children": [ - 4375 - ] - } - ] - }, - { - "id": 4382, - "name": "Discount", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A discount can be applied to a cart for promotional purposes." - } - ] - }, - "children": [ - { - "id": 4383, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4384, - "name": "new Discount", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A discount can be applied to a cart for promotional purposes." - } - ] - }, - "type": { - "type": "reference", - "target": 4382, - "name": "Discount", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4385, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The code that a Discount is identifed by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4383 - ] - }, - { - "title": "Properties", - "children": [ - 4385 - ] - } - ] - }, - { - "id": 4777, - "name": "Discount", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A discount can be applied to a cart for promotional purposes." - } - ] - }, - "children": [ - { - "id": 4778, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4779, - "name": "new Discount", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A discount can be applied to a cart for promotional purposes." - } - ] - }, - "type": { - "type": "reference", - "target": 4777, - "name": "Discount", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4780, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The code of the discount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4778 - ] - }, - { - "title": "Properties", - "children": [ - 4780 - ] - } - ] - }, - { - "id": 3908, - "name": "EmptyQueryParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 3909, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 3910, - "name": "new EmptyQueryParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 3908, - "name": "EmptyQueryParams", - "package": "@medusajs/medusa" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3909 - ] - } - ] - }, - { - "id": 3823, - "name": "FilterableBatchJobProps", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 3824, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 3825, - "name": "new FilterableBatchJobProps", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 3823, - "name": "FilterableBatchJobProps", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 3830, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 3829, - "name": "created_by", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 3826, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 3827, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 3798, - "name": "BatchJobStatus", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 3828, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 3831, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3824 - ] - }, - { - "title": "Properties", - "children": [ - 3830, - 3829, - 3826, - 3827, - 3828, - 3831 - ] - } - ] - }, - { - "id": 4332, - "name": "FilterableCustomerGroupProps", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on the retrieved customer groups." - } - ] - }, - "children": [ - { - "id": 4333, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4334, - "name": "new FilterableCustomerGroupProps", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4332, - "name": "FilterableCustomerGroupProps", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4339, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the customer groups' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 4340, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter customer groups by their associated discount condition's ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4335, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter customer groups by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 4337, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Names to filter customer groups by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4336, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search customer groups by their name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4338, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the customer groups' " - }, - { - "kind": "code", - "text": "`update_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4333 - ] - }, - { - "title": "Properties", - "children": [ - 4339, - 4340, - 4335, - 4337, - 4336, - 4338 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 159, - "name": "AdminGetCustomerGroupsParams" - } - ] - }, - { - "id": 4067, - "name": "FilterablePriceListProps", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on the retrieved price lists." - } - ] - }, - "children": [ - { - "id": 4068, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4069, - "name": "new FilterablePriceListProps", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4067, - "name": "FilterablePriceListProps", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4077, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the price lists' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 4074, - "name": "customer_groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter price lists by their associated customer groups." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4079, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the price lists' " - }, - { - "kind": "code", - "text": "`deleted_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 4075, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description to filter price lists by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4070, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter price lists by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4073, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name to filter price lists by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4071, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search terms to search price lists' description, name, and customer group's name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4072, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statuses to filter price lists by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4064, - "name": "PriceListStatus", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 4076, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Types to filter price lists by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4061, - "name": "PriceListType", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 4078, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the price lists' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4068 - ] - }, - { - "title": "Properties", - "children": [ - 4077, - 4074, - 4079, - 4075, - 4070, - 4073, - 4071, - 4072, - 4076, - 4078 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1129, - "name": "AdminGetPriceListPaginationParams" - } - ] - }, - { - "id": 4622, - "name": "FilterableProductProps", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on retrieved products." - } - ] - }, - "children": [ - { - "id": 4623, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4624, - "name": "new FilterableProductProps", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4622, - "name": "FilterableProductProps", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4638, - "name": "category_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated product category's ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4629, - "name": "collection_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated product collection's ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4640, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the products' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 4642, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the products' " - }, - { - "kind": "code", - "text": "`deleted_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 4632, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4637, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated discount condition's ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4633, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Handle to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4625, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter products by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 4639, - "name": "include_category_children", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include product category children in the response." - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "text", - "text": "product_categories" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4634, - "name": "is_giftcard", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by whether they're gift cards." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4628, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated price lists' ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4626, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search products' title, description, variants' title and sku, and collections' title." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4636, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated sales channels' ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4627, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statuses to filter products by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product.ts", - "qualifiedName": "ProductStatus" - }, - "name": "ProductStatus", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 4630, - "name": "tags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated tags' value." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4631, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Title to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4635, - "name": "type_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated product type's ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4641, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the products' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4623 - ] - }, - { - "title": "Properties", - "children": [ - 4638, - 4629, - 4640, - 4642, - 4632, - 4637, - 4633, - 4625, - 4639, - 4634, - 4628, - 4626, - 4636, - 4627, - 4630, - 4631, - 4635, - 4641 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1407, - "name": "AdminGetProductsParams" - } - ] - }, - { - "id": 3968, - "name": "FindPaginationParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how a list of data is paginated." - } - ] - }, - "children": [ - { - "id": 3969, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 3970, - "name": "new FindPaginationParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 3968, - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 3972, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20" - }, - { - "id": 3971, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3969 - ] - }, - { - "title": "Properties", - "children": [ - 3972, - 3971 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 121, - "name": "AdminGetCurrenciesParams" - }, - { - "type": "reference", - "target": 1263, - "name": "AdminGetProductTypesParams" - }, - { - "type": "reference", - "target": 2407, - "name": "StoreGetProductTagsParams" - }, - { - "type": "reference", - "target": 2425, - "name": "StoreGetProductTypesParams" - } - ] - }, - { - "id": 3963, - "name": "FindParams", + "id": 273, + "name": "AdminPostDiscountsParams", "variant": "declaration", "kind": 128, "flags": {}, @@ -58179,10287 +8800,39 @@ }, "children": [ { - "id": 3964, + "id": 274, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 3965, - "name": "new FindParams", + "id": 275, + "name": "new AdminPostDiscountsParams", "variant": "signature", "kind": 16384, "flags": {}, "type": { "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 3966, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3967, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3964 - ] - }, - { - "title": "Properties", - "children": [ - 3966, - 3967 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 154, - "name": "AdminGetCustomerGroupsGroupParams" - }, - { - "type": "reference", - "target": 238, - "name": "AdminPostDiscountsDiscountConditionsParams" - }, - { - "type": "reference", - "target": 273, - "name": "AdminPostDiscountsParams" - }, - { - "type": "reference", - "target": 284, - "name": "AdminDeleteDiscountsDiscountConditionsConditionParams" - }, - { - "type": "reference", - "target": 289, - "name": "AdminGetDiscountsDiscountConditionsConditionParams" - }, - { - "type": "reference", - "target": 294, - "name": "AdminGetDiscountParams" - }, - { - "type": "reference", - "target": 299, - "name": "AdminGetDiscountsDiscountCodeParams" - }, - { - "type": "reference", - "target": 324, - "name": "AdminPostDiscountsDiscountConditionsConditionParams" - }, - { - "type": "reference", - "target": 359, - "name": "AdminPostDiscountsDiscountParams" - }, - { - "type": "reference", - "target": 370, - "name": "AdminPostDiscountsDiscountConditionsConditionBatchParams" - }, - { - "type": "reference", - "target": 375, - "name": "AdminDeleteDiscountsDiscountConditionsConditionBatchParams" - }, - { - "type": "reference", - "target": 526, - "name": "AdminPostInventoryItemsParams" - }, - { - "type": "reference", - "target": 537, - "name": "AdminPostInventoryItemsItemLocationLevelsParams" - }, - { - "type": "reference", - "target": 542, - "name": "AdminGetInventoryItemsItemParams" - }, - { - "type": "reference", - "target": 568, - "name": "AdminGetInventoryItemsItemLocationLevelsParams" - }, - { - "type": "reference", - "target": 590, - "name": "AdminPostInventoryItemsInventoryItemParams" - }, - { - "type": "reference", - "target": 600, - "name": "AdminPostInventoryItemsItemLocationLevelsLevelParams" - }, - { - "type": "reference", - "target": 699, - "name": "GetOrderEditsOrderEditParams" - }, - { - "type": "reference", - "target": 743, - "name": "AdminPostOrdersOrderShippingMethodsParams" - }, - { - "type": "reference", - "target": 748, - "name": "AdminPostOrdersOrderArchiveParams" - }, - { - "type": "reference", - "target": 753, - "name": "AdminPostOrdersClaimCancel" - }, - { - "type": "reference", - "target": 764, - "name": "AdminPostOrdersOrderFulfillementsCancelParams" - }, - { - "type": "reference", - "target": 769, - "name": "AdminPostOrdersClaimFulfillmentsCancelParams" - }, - { - "type": "reference", - "target": 774, - "name": "AdminPostOrdersOrderSwapFulfillementsCancelParams" - }, - { - "type": "reference", - "target": 779, - "name": "AdminPostOrdersOrderCancel" - }, - { - "type": "reference", - "target": 784, - "name": "AdminPostOrdersSwapCancelParams" - }, - { - "type": "reference", - "target": 789, - "name": "AdminPostOrdersOrderCaptureParams" - }, - { - "type": "reference", - "target": 794, - "name": "AdminPostOrdersOrderCompleteParams" - }, - { - "type": "reference", - "target": 812, - "name": "AdminPostOrdersOrderClaimsParams" - }, - { - "type": "reference", - "target": 822, - "name": "AdminPostOrdersOrderClaimsClaimShipmentsParams" - }, - { - "type": "reference", - "target": 841, - "name": "AdminPostOrdersOrderFulfillmentsParams" - }, - { - "type": "reference", - "target": 852, - "name": "AdminPostOrdersOrderShipmentParams" - }, - { - "type": "reference", - "target": 868, - "name": "AdminPostOrdersOrderSwapsParams" - }, - { - "type": "reference", - "target": 879, - "name": "AdminPostOrdersOrderSwapsSwapShipmentsParams" - }, - { - "type": "reference", - "target": 890, - "name": "AdminPostOrdersOrderClaimsClaimFulfillmentsParams" - }, - { - "type": "reference", - "target": 901, - "name": "AdminPostOrdersOrderSwapsSwapFulfillmentsParams" - }, - { - "type": "reference", - "target": 906, - "name": "AdminGetOrdersOrderParams" - }, - { - "type": "reference", - "target": 934, - "name": "AdminPostOrdersOrderSwapsSwapProcessPaymentParams" - }, - { - "type": "reference", - "target": 946, - "name": "AdminPostOrdersOrderRefundsParams" - }, - { - "type": "reference", - "target": 961, - "name": "AdminPostOrdersOrderReturnsParams" - }, - { - "type": "reference", - "target": 973, - "name": "AdminPostOrdersOrderClaimsClaimParams" - }, - { - "type": "reference", - "target": 991, - "name": "AdminPostOrdersOrderParams" - }, - { - "type": "reference", - "target": 1006, - "name": "AdminGetPaymentCollectionsParams" - }, - { - "type": "reference", - "target": 1023, - "name": "GetPaymentsParams" - }, - { - "type": "reference", - "target": 1168, - "name": "AdminGetProductCategoryParams" - }, - { - "type": "reference", - "target": 1197, - "name": "AdminPostProductCategoriesParams" - }, - { - "type": "reference", - "target": 1213, - "name": "AdminPostProductCategoriesCategoryParams" - }, - { - "type": "reference", - "target": 1222, - "name": "AdminPostProductCategoriesCategoryProductsBatchParams" - }, - { - "type": "reference", - "target": 1231, - "name": "AdminDeleteProductCategoriesCategoryProductsBatchParams" - }, - { - "type": "reference", - "target": 1402, - "name": "AdminGetProductParams" - }, - { - "type": "reference", - "target": 1826, - "name": "AdminPostStockLocationsParams" - }, - { - "type": "reference", - "target": 1831, - "name": "AdminGetStockLocationsLocationParams" - }, - { - "type": "reference", - "target": 1855, - "name": "AdminPostStockLocationsLocationParams" - }, - { - "type": "reference", - "target": 2089, - "name": "AdminGetVariantParams" - }, - { - "type": "reference", - "target": 2329, - "name": "StoreGetOrdersParams" - }, - { - "type": "reference", - "target": 2352, - "name": "StoreGetPaymentCollectionsParams" - }, - { - "type": "reference", - "target": 2384, - "name": "StoreGetProductCategoriesCategoryParams" - }, - { - "type": "reference", - "target": 2534, - "name": "StoreGetRegionsRegionParams" - }, - { - "type": "reference", - "target": 4781, - "name": "PriceSelectionParams" - } - ] - }, - { - "id": 1545, - "name": "FulfillmentOption", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 1546, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1547, - "name": "new FulfillmentOption", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1545, - "name": "FulfillmentOption", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1549, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "fulfillment provider options" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - }, - { - "id": 1548, - "name": "provider_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the fulfillment provider" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1546 - ] - }, - { - "title": "Properties", - "children": [ - 1549, - 1548 - ] - } - ] - }, - { - "id": 699, - "name": "GetOrderEditsOrderEditParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 700, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 701, - "name": "new GetOrderEditsOrderEditParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 699, - "name": "GetOrderEditsOrderEditParams", + "target": 273, + "name": "AdminPostDiscountsParams", "package": "@medusajs/medusa" }, "inheritedFrom": { "type": "reference", - "target": 3965, + "target": 3972, "name": "FindParams.constructor" } } ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 702, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 703, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 700 - ] - }, - { - "title": "Properties", - "children": [ - 702, - 703 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 704, - "name": "GetOrderEditsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved order edits." - } - ] - }, - "children": [ - { - "id": 705, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 706, - "name": "new GetOrderEditsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 707, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "target": 704, - "name": "GetOrderEditsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" - } - }, - { - "id": 710, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).expand" - } - }, - { - "id": 711, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).fields" - } - }, - { - "id": 713, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).limit" - } - }, - { - "id": 712, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).offset" - } - }, - { - "id": 709, - "name": "order_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter the order edits by their associated order's ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 708, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search order edits by their internal note." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 705 - ] - }, - { - "title": "Properties", - "children": [ - 710, - 711, - 713, - 712, - 709, - 708 - ] - } - ], - "extendedTypes": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - } - ] - }, - { - "id": 1023, - "name": "GetPaymentsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 1024, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1025, - "name": "new GetPaymentsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1023, - "name": "GetPaymentsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 1026, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 1027, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1024 - ] - }, - { - "title": "Properties", - "children": [ - 1026, - 1027 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 1519, - "name": "GetPublishableApiKeySalesChannelsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter the sales channels." - } - ] - }, - "children": [ - { - "id": 1520, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1521, - "name": "new GetPublishableApiKeySalesChannelsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 1519, - "name": "GetPublishableApiKeySalesChannelsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 1522, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search sales channels' names and descriptions." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1520 - ] - }, - { - "title": "Properties", - "children": [ - 1522 - ] - } - ] - }, - { - "id": 1523, - "name": "GetPublishableApiKeysParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved publishable API keys." - } - ] - }, - "children": [ - { - "id": 1524, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 1525, - "name": "new GetPublishableApiKeysParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 1526, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "target": 1523, - "name": "GetPublishableApiKeysParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" - } - }, - { - "id": 1528, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).expand" - } - }, - { - "id": 1529, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).fields" - } - }, - { - "id": 1531, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).limit" - } - }, - { - "id": 1530, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).offset" - } - }, - { - "id": 1527, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search publishable API keys' titles." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 1524 - ] - }, - { - "title": "Properties", - "children": [ - 1528, - 1529, - 1531, - 1530, - 1527 - ] - } - ], - "extendedTypes": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - } - ] - }, - { - "id": 4773, - "name": "GiftCard", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gift Cards are redeemable and represent a value that can be used towards the payment of an Order." - } - ] - }, - "children": [ - { - "id": 4774, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4775, - "name": "new GiftCard", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gift Cards are redeemable and represent a value that can be used towards the payment of an Order." - } - ] - }, - "type": { - "type": "reference", - "target": 4773, - "name": "GiftCard", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4776, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The code of a gift card." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4774 - ] - }, - { - "title": "Properties", - "children": [ - 4776 - ] - } - ] - }, - { - "id": 4347, - "name": "Group", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4348, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4349, - "name": "new Group", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4347, - "name": "Group", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4350, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a customer group" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4348 - ] - }, - { - "title": "Properties", - "children": [ - 4350 - ] - } - ] - }, - { - "id": 2012, - "name": "IAdminPostUploadsFileReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2013, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2014, - "name": "new IAdminPostUploadsFileReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2012, - "name": "IAdminPostUploadsFileReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2015, - "name": "originalName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2016, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2013 - ] - }, - { - "title": "Properties", - "children": [ - 2015, - 2016 - ] - } - ] - }, - { - "id": 5007, - "name": "Image", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An Image is used to store details about uploaded images. Images are uploaded by the File Service, and the URL is provided by the File Service." - } - ] - }, - "children": [ - { - "id": 5008, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 5009, - "name": "new Image", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An Image is used to store details about uploaded images. Images are uploaded by the File Service, and the URL is provided by the File Service." - } - ] - }, - "type": { - "type": "reference", - "target": 5007, - "name": "Image", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 5010, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Image ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5011, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Image URL" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 5008 - ] - }, - { - "title": "Properties", - "children": [ - 5010, - 5011 - ] - } - ] - }, - { - "id": 2146, - "name": "Item", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2147, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2148, - "name": "new Item", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2146, - "name": "Item", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2150, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity to add into the cart." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2149, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2147 - ] - }, - { - "title": "Properties", - "children": [ - 2150, - 2149 - ] - } - ] - }, - { - "id": 4364, - "name": "Item", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4365, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4366, - "name": "new Item", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4364, - "name": "Item", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4371, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The optional key-value map with additional details about the line item." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 4370, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity of the line item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4367, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the line item if `variant_id` is not provided." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4368, - "name": "unit_price", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The custom price of the line item. If a `variant_id` is supplied, the price provided here will override the variant's price." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4369, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Product Variant associated with the line item. If the line item is custom, the `variant_id` should be omitted." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4365 - ] - }, - { - "title": "Properties", - "children": [ - 4371, - 4370, - 4367, - 4368, - 4369 - ] - } - ] - }, - { - "id": 4423, - "name": "Item", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4424, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4425, - "name": "new Item", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4423, - "name": "Item", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4431, - "name": "images", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of image URL's that will be associated with the Claim" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4426, - "name": "item_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Line Item that will be claimed." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4428, - "name": "note", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Short text describing the Claim Item in further detail." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4427, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items that will be returned" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4429, - "name": "reason", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The reason for the Claim" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/claim-item.ts", - "qualifiedName": "ClaimReason" - }, - "name": "ClaimReason", - "package": "@medusajs/medusa" - } - }, - { - "id": 4430, - "name": "tags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of tags to add to the Claim Item" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4424 - ] - }, - { - "title": "Properties", - "children": [ - 4431, - 4426, - 4428, - 4427, - 4429, - 4430 - ] - } - ] - }, - { - "id": 4449, - "name": "Item", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4450, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4451, - "name": "new Item", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4449, - "name": "Item", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4452, - "name": "item_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Line Item to fulfill." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4453, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity of the Line Item to fulfill." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4450 - ] - }, - { - "title": "Properties", - "children": [ - 4452, - 4453 - ] - } - ] - }, - { - "id": 4507, - "name": "Item", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4508, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4509, - "name": "new Item", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4507, - "name": "Item", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4510, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Claim Item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4513, - "name": "images", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list of image URL's that will be associated with the Claim" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5007, - "name": "Image", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 4515, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4511, - "name": "note", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Short text describing the Claim Item in further detail." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4512, - "name": "reason", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The reason for the Claim" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4514, - "name": "tags", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A list o tags to add to the Claim Item" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5012, - "name": "Tag", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4508 - ] - }, - { - "title": "Properties", - "children": [ - 4510, - 4513, - 4515, - 4511, - 4512, - 4514 - ] - } - ] - }, - { - "id": 4684, - "name": "Item", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4685, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4686, - "name": "new Item", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4684, - "name": "Item", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4687, - "name": "item_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Line Item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4688, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity of the Line Item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4685 - ] - }, - { - "title": "Properties", - "children": [ - 4687, - 4688 - ] - } - ] - }, - { - "id": 4789, - "name": "Item", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4790, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4791, - "name": "new Item", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4789, - "name": "Item", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4792, - "name": "item_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the line item to return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4795, - "name": "note", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A note to add to the item returned." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4793, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity to return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4794, - "name": "reason_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the return reason. Return reasons can be retrieved from the List Return Reasons API Route." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4790 - ] - }, - { - "title": "Properties", - "children": [ - 4792, - 4795, - 4793, - 4794 - ] - } - ] - }, - { - "id": 4801, - "name": "Item", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4802, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4803, - "name": "new Item", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4801, - "name": "Item", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4804, - "name": "item_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the order's line item to return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4807, - "name": "note", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The note to add to the item being swapped." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4805, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity to return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4806, - "name": "reason_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the reason of this return. Return reasons can be retrieved from the List Return Reasons API Route." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4802 - ] - }, - { - "title": "Properties", - "children": [ - 4804, - 4807, - 4805, - 4806 - ] - } - ] - }, - { - "id": 4813, - "name": "MedusaError", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Standardized error to be used across Medusa project." - } - ] - }, - "children": [ - { - "id": 4830, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4831, - "name": "new MedusaError", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Creates a standardized error to be used across Medusa project." - } - ] - }, - "parameters": [ - { - "id": 4832, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "type of error" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4833, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "message to go along with error" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4834, - "name": "code", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "code of error" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4835, - "name": "params", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "params" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 4813, - "name": "MedusaError", - "package": "medusa-core-utils" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - } - ], - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.constructor" - } - }, - { - "id": 4838, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4839, - "name": "date", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 4837, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Error.message" - } - }, - { - "id": 4836, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4826, - "name": "Codes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 4827, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4829, - "name": "CART_INCOMPATIBLE_STATE", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4828, - "name": "INSUFFICIENT_INVENTORY", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4829, - 4828 - ] - } - ] - } - } - }, - { - "id": 4814, - "name": "Types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isStatic": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 4815, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4824, - "name": "CONFLICT", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4816, - "name": "DB_ERROR", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Errors stemming from the database" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4817, - "name": "DUPLICATE_ERROR", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4818, - "name": "INVALID_ARGUMENT", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4819, - "name": "INVALID_DATA", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4822, - "name": "NOT_ALLOWED", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4821, - "name": "NOT_FOUND", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4825, - "name": "PAYMENT_AUTHORIZATION_ERROR", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4820, - "name": "UNAUTHORIZED", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4823, - "name": "UNEXPECTED_STATE", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4824, - 4816, - 4817, - 4818, - 4819, - 4822, - 4821, - 4825, - 4820, - 4823 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4830 - ] - }, - { - "title": "Properties", - "children": [ - 4838, - 4839, - 4837, - 4836, - 4826, - 4814 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Error" - }, - "name": "Error", - "package": "typescript" - } - ] - }, - { - "id": 3928, - "name": "NumericalComparisonOperator", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields used to apply flexible filters on numbers." - } - ] - }, - "children": [ - { - "id": 3929, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 3930, - "name": "new NumericalComparisonOperator", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 3928, - "name": "NumericalComparisonOperator", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 3932, - "name": "gt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered number must be greater than this value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3933, - "name": "gte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered number must be greater than or equal to this value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3931, - "name": "lt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered number must be less than this value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3934, - "name": "lte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered number must be less than or equal to this value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3929 - ] - }, - { - "title": "Properties", - "children": [ - 3932, - 3933, - 3931, - 3934 - ] - } - ] - }, - { - "id": 4702, - "name": "OptionRequirement", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4703, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4704, - "name": "new OptionRequirement", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4702, - "name": "OptionRequirement", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4706, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount to compare with." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4705, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the requirement" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", - "qualifiedName": "RequirementType" - }, - "name": "RequirementType", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4703 - ] - }, - { - "title": "Properties", - "children": [ - 4706, - 4705 - ] - } - ] - }, - { - "id": 4707, - "name": "OptionRequirement", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4708, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4709, - "name": "new OptionRequirement", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4707, - "name": "OptionRequirement", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4712, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount to compare with." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4710, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of an existing requirement. If an ID is passed, the existing requirement's details are updated. Otherwise, a new requirement is created." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4711, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the requirement" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4708 - ] - }, - { - "title": "Properties", - "children": [ - 4712, - 4710, - 4711 - ] - } - ] - }, - { - "id": 4495, - "name": "OrdersReturnItem", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4496, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4497, - "name": "new OrdersReturnItem", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4495, - "name": "OrdersReturnItem", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4498, - "name": "item_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Line Item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4501, - "name": "note", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional note with information about the Return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4499, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity of the Line Item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4500, - "name": "reason_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Return Reason to use." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4496 - ] - }, - { - "title": "Properties", - "children": [ - 4498, - 4501, - 4499, - 4500 - ] - } - ] - }, - { - "id": 4523, - "name": "PaymentMethod", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attributes to update in the order's payment method." - } - ] - }, - "children": [ - { - "id": 4524, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4525, - "name": "new PaymentMethod", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4523, - "name": "PaymentMethod", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4527, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data to attach to the payment." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4526, - "name": "provider_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the payment provider used in the order." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4524 - ] - }, - { - "title": "Properties", - "children": [ - 4527, - 4526 - ] - } - ] - }, - { - "id": 4781, - "name": "PriceSelectionParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The context to apply on retrieved prices." - } - ] - }, - "children": [ - { - "id": 4782, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4783, - "name": "new PriceSelectionParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4781, - "name": "PriceSelectionParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 4784, - "name": "cart_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a cart ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4786, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a currency code." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4787, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 4788, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - }, - { - "id": 4785, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a region ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4782 - ] - }, - { - "title": "Properties", - "children": [ - 4784, - 4786, - 4787, - 4788, - 4785 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2483, - "name": "StoreGetProductsPaginationParams" - }, - { - "type": "reference", - "target": 2598, - "name": "StoreGetVariantsVariantParams" - }, - { - "type": "reference", - "target": 2607, - "name": "StoreGetVariantsParams" - }, - { - "type": "reference", - "target": 4764, - "name": "AdminPriceSelectionParams" - } - ] - }, - { - "id": 4558, - "name": "ProductBatchProductCategory", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4559, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4560, - "name": "new ProductBatchProductCategory", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4558, - "name": "ProductBatchProductCategory", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4561, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4559 - ] - }, - { - "title": "Properties", - "children": [ - 4561 - ] - } - ] - }, - { - "id": 4680, - "name": "ProductBatchSalesChannel", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4681, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4682, - "name": "new ProductBatchSalesChannel", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4680, - "name": "ProductBatchSalesChannel", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4683, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the sales channel" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4681 - ] - }, - { - "title": "Properties", - "children": [ - 4683 - ] - } - ] - }, - { - "id": 4583, - "name": "ProductOptionReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4584, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4585, - "name": "new ProductOptionReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4583, - "name": "ProductOptionReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4586, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Product Option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4584 - ] - }, - { - "title": "Properties", - "children": [ - 4586 - ] - } - ] - }, - { - "id": 4579, - "name": "ProductProductCategoryReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4580, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4581, - "name": "new ProductProductCategoryReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4579, - "name": "ProductProductCategoryReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4582, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a Product Category." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4580 - ] - }, - { - "title": "Properties", - "children": [ - 4582 - ] - } - ] - }, - { - "id": 4575, - "name": "ProductSalesChannelReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4576, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4577, - "name": "new ProductSalesChannelReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4575, - "name": "ProductSalesChannelReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4578, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of an existing Sales channel." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4576 - ] - }, - { - "title": "Properties", - "children": [ - 4578 - ] - } - ] - }, - { - "id": 4570, - "name": "ProductTagReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4571, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4572, - "name": "new ProductTagReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4570, - "name": "ProductTagReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4573, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of an existing Product Tag. If not provided, a new product tag will be created." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4574, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the Tag. If the `id` is provided, the value of the existing tag will be updated." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4571 - ] - }, - { - "title": "Properties", - "children": [ - 4573, - 4574 - ] - } - ] - }, - { - "id": 4565, - "name": "ProductTypeReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of a product type, used to create or update an existing product type." - } - ] - }, - "children": [ - { - "id": 4566, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4567, - "name": "new ProductTypeReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4565, - "name": "ProductTypeReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4568, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product type. It's only required when referring to an existing product type." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4569, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the product type." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4566 - ] - }, - { - "title": "Properties", - "children": [ - 4568, - 4569 - ] - } - ] - }, - { - "id": 4617, - "name": "ProductVariantOptionReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4618, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4619, - "name": "new ProductVariantOptionReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4617, - "name": "ProductVariantOptionReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4621, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Product Option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4620, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A value to give to the Product Option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4618 - ] - }, - { - "title": "Properties", - "children": [ - 4621, - 4620 - ] - } - ] - }, - { - "id": 4675, - "name": "ProductVariantOptionReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4676, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4677, - "name": "new ProductVariantOptionReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4675, - "name": "ProductVariantOptionReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4679, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Product Option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4678, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the Product Option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4676 - ] - }, - { - "title": "Properties", - "children": [ - 4679, - 4678 - ] - } - ] - }, - { - "id": 5017, - "name": "ProductVariantOptionReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 5018, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 5019, - "name": "new ProductVariantOptionReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 5017, - "name": "ProductVariantOptionReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 5020, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to give for the Product Option at the same index in the Product's `options` field." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 5018 - ] - }, - { - "title": "Properties", - "children": [ - 5020 - ] - } - ] - }, - { - "id": 5021, - "name": "ProductVariantOptionReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 5022, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 5023, - "name": "new ProductVariantOptionReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 5021, - "name": "ProductVariantOptionReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 5025, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5024, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the Product Option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 5022 - ] - }, - { - "title": "Properties", - "children": [ - 5025, - 5024 - ] - } - ] - }, - { - "id": 4609, - "name": "ProductVariantPricesCreateReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4610, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4611, - "name": "new ProductVariantPricesCreateReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4609, - "name": "ProductVariantPricesCreateReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4614, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4613, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The 3 character ISO currency code the price will be used in. This is only required if `region_id` is not provided." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4616, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum quantity required to be added to the cart for the price to be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4615, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The minimum quantity required to be added to the cart for the price to be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4612, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Region the price will be used in. This is only required if `currency_code` is not provided." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4610 - ] - }, - { - "title": "Properties", - "children": [ - 4614, - 4613, - 4616, - 4615, - 4612 - ] - } - ] - }, - { - "id": 4666, - "name": "ProductVariantPricesUpdateReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4667, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4668, - "name": "new ProductVariantPricesUpdateReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4666, - "name": "ProductVariantPricesUpdateReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4672, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4671, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The 3 character ISO currency code the price will be used in. This is only required if `region_id` is not provided." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4669, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Price. If provided, the existing price will be updated. Otherwise, a new price will be created." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4674, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum quantity required to be added to the cart for the price to be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4673, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The minimum quantity required to be added to the cart for the price to be used." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4670, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Region the price will be used in. This is only required if `currency_code` is not provided." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4667 - ] - }, - { - "title": "Properties", - "children": [ - 4672, - 4671, - 4669, - 4674, - 4673, - 4670 - ] - } - ] - }, - { - "id": 4587, - "name": "ProductVariantReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4588, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4589, - "name": "new ProductVariantReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4587, - "name": "ProductVariantReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4597, - "name": "allow_backorder", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the Product Variant can be purchased when out of stock." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4594, - "name": "barcode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A generic GTIN field of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4592, - "name": "ean", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The EAN number of the item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4601, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4595, - "name": "hs_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Harmonized System code of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4596, - "name": "inventory_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount of stock kept of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 4600, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The length of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4598, - "name": "manage_inventory", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether Medusa should keep track of the inventory of this Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4605, - "name": "material", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The material composition of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4606, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4604, - "name": "mid_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Manufacturer Identification code of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4608, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of Product Option values that the variant corresponds to. The option values should be added into the array in the same index as in the `options` field of the product." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5017, - "name": "ProductVariantOptionReq", - "package": "@medusajs/medusa" - } - }, - "defaultValue": "[]" - }, - { - "id": 4603, - "name": "origin_country", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The country of origin of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4607, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product variant prices. A product variant can have different prices for each region or currency code." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4609, - "name": "ProductVariantPricesCreateReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 4591, - "name": "sku", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique SKU of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4590, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4593, - "name": "upc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The UPC number of the item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4599, - "name": "weight", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The wieght of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4602, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4588 - ] - }, - { - "title": "Properties", - "children": [ - 4597, - 4594, - 4592, - 4601, - 4595, - 4596, - 4600, - 4598, - 4605, - 4606, - 4604, - 4608, - 4603, - 4607, - 4591, - 4590, - 4593, - 4599, - 4602 - ] - } - ] - }, - { - "id": 4643, - "name": "ProductVariantReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4644, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4645, - "name": "new ProductVariantReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4643, - "name": "ProductVariantReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4654, - "name": "allow_backorder", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the product variant can be purchased when out of stock." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4651, - "name": "barcode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A generic GTIN field of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4649, - "name": "ean", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The EAN number of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4658, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4652, - "name": "hs_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Harmonized System code of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4646, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The id of an existing product variant. If provided, the details of the product variant will be updated. If not, a new product variant will be created." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4653, - "name": "inventory_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount of stock kept of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4657, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The length of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4655, - "name": "manage_inventory", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether Medusa should keep track of the inventory of this product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4662, - "name": "material", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The material composition of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4663, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs with additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4661, - "name": "mid_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Manufacturer Identification code of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4665, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of Product Option values that the variant corresponds to." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5021, - "name": "ProductVariantOptionReq", - "package": "@medusajs/medusa" - } - }, - "defaultValue": "[]" - }, - { - "id": 4660, - "name": "origin_country", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The country of origin of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4664, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product variant prices. A product variant can have different prices for each region or currency code." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4666, - "name": "ProductVariantPricesUpdateReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 4648, - "name": "sku", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique SKU of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4647, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4650, - "name": "upc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The UPC number of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4656, - "name": "weight", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The weight of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4659, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4644 - ] - }, - { - "title": "Properties", - "children": [ - 4654, - 4651, - 4649, - 4658, - 4652, - 4646, - 4653, - 4657, - 4655, - 4662, - 4663, - 4661, - 4665, - 4660, - 4664, - 4648, - 4647, - 4650, - 4656, - 4659 - ] - } - ] - }, - { - "id": 4454, - "name": "ReturnItem", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A return item represents a line item in an order that is to be returned. It includes details related to the return and the reason behind it." - } - ] - }, - "children": [ - { - "id": 4455, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4456, - "name": "new ReturnItem", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A return item represents a line item in an order that is to be returned. It includes details related to the return and the reason behind it." - } - ] - }, - "type": { - "type": "reference", - "target": 4454, - "name": "ReturnItem", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4457, - "name": "item_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Line Item that will be returned." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4460, - "name": "note", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional note with information about the Return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4458, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items that will be returned" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4459, - "name": "reason_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Return Reason to use." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4455 - ] - }, - { - "title": "Properties", - "children": [ - 4457, - 4460, - 4458, - 4459 - ] - } - ] - }, - { - "id": 4432, - "name": "ReturnShipping", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The return's shipping method details." - } - ] - }, - "children": [ - { - "id": 4433, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4434, - "name": "new ReturnShipping", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4432, - "name": "ReturnShipping", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4435, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the shipping option used for the return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4436, - "name": "price", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The shipping method's price." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4433 - ] - }, - { - "title": "Properties", - "children": [ - 4435, - 4436 - ] - } - ] - }, - { - "id": 4461, - "name": "ReturnShipping", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The return's shipping method details." - } - ] - }, - "children": [ - { - "id": 4462, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4463, - "name": "new ReturnShipping", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4461, - "name": "ReturnShipping", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4464, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the shipping option used for the return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4465, - "name": "price", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The shipping method's price." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4462 - ] - }, - { - "title": "Properties", - "children": [ - 4464, - 4465 - ] - } - ] - }, - { - "id": 4502, - "name": "ReturnShipping", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The return's shipping method details." - } - ] - }, - "children": [ - { - "id": 4503, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4504, - "name": "new ReturnShipping", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4502, - "name": "ReturnShipping", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4505, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the shipping option used for the return." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4506, - "name": "price", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The shipping method's price." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4503 - ] - }, - { - "title": "Properties", - "children": [ - 4505, - 4506 - ] - } - ] - }, - { - "id": 4796, - "name": "ReturnShipping", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4797, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4798, - "name": "new ReturnShipping", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4796, - "name": "ReturnShipping", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4799, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Shipping Option to create the Shipping Method from." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4797 - ] - }, - { - "title": "Properties", - "children": [ - 4799 - ] - } - ] - }, - { - "id": 2325, - "name": "ShippingAddressPayload", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on the order's shipping address." - } - ] - }, - "children": [ - { - "id": 2326, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2327, - "name": "new ShippingAddressPayload", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2325, - "name": "ShippingAddressPayload", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2328, - "name": "postal_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postal code." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2326 - ] - }, - { - "title": "Properties", - "children": [ - 2328 - ] - } - ] - }, - { - "id": 4376, - "name": "ShippingMethod", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." - } - ] - }, - "children": [ - { - "id": 4377, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4378, - "name": "new ShippingMethod", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." - } - ] - }, - "type": { - "type": "reference", - "target": 4376, - "name": "ShippingMethod", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4380, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The optional additional data needed for the shipping method" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 4379, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the shipping option in use" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4381, - "name": "price", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price of the shipping method." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4377 - ] - }, - { - "title": "Properties", - "children": [ - 4380, - 4379, - 4381 - ] - } - ] - }, - { - "id": 4442, - "name": "ShippingMethod", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." - } - ] - }, - "children": [ - { - "id": 4443, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4444, - "name": "new ShippingMethod", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." - } - ] - }, - "type": { - "type": "reference", - "target": 4442, - "name": "ShippingMethod", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4448, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4445, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of an existing Shipping Method" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4446, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Shipping Option to create a Shipping Method from" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4447, - "name": "price", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price to charge for the Shipping Method" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4443 - ] - }, - { - "title": "Properties", - "children": [ - 4448, - 4445, - 4446, - 4447 - ] - } - ] - }, - { - "id": 4516, - "name": "ShippingMethod", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." - } - ] - }, - "children": [ - { - "id": 4517, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4518, - "name": "new ShippingMethod", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." - } - ] - }, - "type": { - "type": "reference", - "target": 4516, - "name": "ShippingMethod", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4522, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional set of key-value pairs to hold additional information." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4519, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of an existing Shipping Method" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4520, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Shipping Option to create a Shipping Method from" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4521, - "name": "price", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price to charge for the Shipping Method" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4517 - ] - }, - { - "title": "Properties", - "children": [ - 4522, - 4519, - 4520, - 4521 - ] - } - ] - }, - { - "id": 4528, - "name": "ShippingMethod", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attributes to update in the order's shipping method." - } - ] - }, - "children": [ - { - "id": 4529, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4530, - "name": "new ShippingMethod", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." - } - ] - }, - "type": { - "type": "reference", - "target": 4528, - "name": "ShippingMethod", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4534, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data to attach to the shipping method." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4535, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The line items associated with this shipping methods." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - }, - { - "id": 4533, - "name": "price", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price of the shipping method." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4532, - "name": "profile_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the shipping profile used in the order." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4531, - "name": "provider_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the shipping provider used in the order." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4529 - ] - }, - { - "title": "Properties", - "children": [ - 4534, - 4535, - 4533, - 4532, - 4531 - ] - } - ] - }, - { - "id": 4731, - "name": "StockLocationAddress", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 4732, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4733, - "name": "new StockLocationAddress", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4731, - "name": "StockLocationAddress", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4734, - "name": "address_1", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4735, - "name": "address_2", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' complement" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4737, - "name": "city", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' city" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4736, - "name": "company", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' company" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4738, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The two character ISO code for the country." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4739, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' phone number" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4740, - "name": "postal_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' postal code" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4741, - "name": "province", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' province" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4732 - ] - }, - { - "title": "Properties", - "children": [ - 4734, - 4735, - 4737, - 4736, - 4738, - 4739, - 4740, - 4741 - ] - } - ] - }, - { - "id": 4742, - "name": "StockLocationAddress", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attributes of a stock location address to create or update." - } - ] - }, - "children": [ - { - "id": 4743, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 4744, - "name": "new StockLocationAddress", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 4742, - "name": "StockLocationAddress", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4745, - "name": "address_1", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "First line address." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4746, - "name": "address_2", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Second line address." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4748, - "name": "city", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "City." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4747, - "name": "company", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Company." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4749, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Country code." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4750, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Phone." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4751, - "name": "postal_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postal code." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4752, - "name": "province", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Province." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 4743 - ] - }, - { - "title": "Properties", - "children": [ - 4745, - 4746, - 4748, - 4747, - 4749, - 4750, - 4751, - 4752 - ] - } - ] - }, - { - "id": 2199, - "name": "StoreGetCollectionsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved product collections." - } - ] - }, - "children": [ - { - "id": 2200, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2201, - "name": "new StoreGetCollectionsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2199, - "name": "StoreGetCollectionsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2205, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the product collections' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date" - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 2202, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Handles to filter product collections by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2203, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n10\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "10" - }, - { - "id": 2204, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 2206, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the product collections' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2200 - ] - }, - { - "title": "Properties", - "children": [ - 2205, - 2202, - 2203, - 2204, - 2206 - ] - } - ] - }, - { - "id": 2238, - "name": "StoreGetCustomersCustomerOrdersPaginationParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how a list of data is paginated." - } - ] - }, - "children": [ - { - "id": 2239, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2240, - "name": "new StoreGetCustomersCustomerOrdersPaginationParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2238, - "name": "StoreGetCustomersCustomerOrdersPaginationParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2244, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2243, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2241, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n10\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "10" - }, - { - "id": 2242, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2239 - ] - }, - { - "title": "Properties", - "children": [ - 2244, - 2243, - 2241, - 2242 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2245, - "name": "StoreGetCustomersCustomerOrdersParams" - } - ] - }, - { - "id": 2245, - "name": "StoreGetCustomersCustomerOrdersParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved orders." - } - ] - }, - "children": [ - { - "id": 2246, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2247, - "name": "new StoreGetCustomersCustomerOrdersParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2245, - "name": "StoreGetCustomersCustomerOrdersParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 2240, - "name": "StoreGetCustomersCustomerOrdersPaginationParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2239, - "name": "StoreGetCustomersCustomerOrdersPaginationParams.constructor" - } - }, - { - "id": 2261, - "name": "canceled_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the orders' " - }, - { - "kind": "code", - "text": "`canceled_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 2254, - "name": "cart_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Cart ID to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2259, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the orders' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 2257, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Currency code to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2253, - "name": "display_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Display ID to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2255, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Email to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2265, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2244, - "name": "StoreGetCustomersCustomerOrdersPaginationParams.expand" - } - }, - { - "id": 2264, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2243, - "name": "StoreGetCustomersCustomerOrdersPaginationParams.fields" - } - }, - { - "id": 2251, - "name": "fulfillment_status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fulfillment statuses to filter orders by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "FulfillmentStatus" - }, - "name": "FulfillmentStatus", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 2248, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2262, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n10\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "10", - "inheritedFrom": { - "type": "reference", - "target": 2241, - "name": "StoreGetCustomersCustomerOrdersPaginationParams.limit" - } - }, - { - "id": 2263, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": 2242, - "name": "StoreGetCustomersCustomerOrdersPaginationParams.offset" - } - }, - { - "id": 2252, - "name": "payment_status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payment statuses to filter orders by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "PaymentStatus" - }, - "name": "PaymentStatus", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 2249, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search orders' display ID, email, shipping address's first name, customer's first name, customer's last name, and customer's phone number." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2256, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Region ID to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2250, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Statuses to filter orders by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "OrderStatus" - }, - "name": "OrderStatus", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 2258, - "name": "tax_rate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tax rate to filter orders by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2260, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the orders' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2246 - ] - }, - { - "title": "Properties", - "children": [ - 2261, - 2254, - 2259, - 2257, - 2253, - 2255, - 2265, - 2264, - 2251, - 2248, - 2262, - 2263, - 2252, - 2249, - 2256, - 2250, - 2258, - 2260 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2238, - "name": "StoreGetCustomersCustomerOrdersPaginationParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 2329, - "name": "StoreGetOrdersParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to narrow down the looked-up order, with configurations applied on the retrieved order." - } - ] - }, - "children": [ - { - "id": 2330, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2331, - "name": "new StoreGetOrdersParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2329, - "name": "StoreGetOrdersParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 2332, - "name": "display_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Display ID of the order." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2333, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Email of the order." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2335, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 2336, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - }, - { - "id": 2334, - "name": "shipping_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter the retrieved order by its shipping address details." - } - ] - }, - "type": { - "type": "reference", - "target": 2325, - "name": "ShippingAddressPayload", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2330 - ] - }, - { - "title": "Properties", - "children": [ - 2332, - 2333, - 2335, - 2336, - 2334 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 2352, - "name": "StoreGetPaymentCollectionsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 2353, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2354, - "name": "new StoreGetPaymentCollectionsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2352, - "name": "StoreGetPaymentCollectionsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 2355, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 2356, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2353 - ] - }, - { - "title": "Properties", - "children": [ - 2355, - 2356 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 2384, - "name": "StoreGetProductCategoriesCategoryParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how data is retrieved." - } - ] - }, - "children": [ - { - "id": 2385, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2386, - "name": "new StoreGetProductCategoriesCategoryParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2384, - "name": "StoreGetProductCategoriesCategoryParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3965, - "name": "FindParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3964, - "name": "FindParams.constructor" - } - }, - { - "id": 2387, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3966, - "name": "FindParams.expand" - } - }, - { - "id": 2388, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3967, - "name": "FindParams.fields" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2385 - ] - }, - { - "title": "Properties", - "children": [ - 2387, - 2388 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 2389, - "name": "StoreGetProductCategoriesParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved product categories." - } - ] - }, - "children": [ - { - "id": 2390, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2391, - "name": "new StoreGetProductCategoriesParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 2392, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "target": 2389, - "name": "StoreGetProductCategoriesParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).constructor" - } - }, - { - "id": 2397, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).expand" - } - }, - { - "id": 2398, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).fields" - } - }, - { - "id": 2394, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Handle to filter product categories by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2396, - "name": "include_descendants_tree", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include child categories in the retrieved categories." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2400, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of product categories returned in the list. Default is " - }, - { - "kind": "code", - "text": "`100`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).limit" - } - }, - { - "id": 2399, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).offset" - } - }, - { - "id": 2395, - "name": "parent_category_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter product categories by the ID of their associated parent category." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 2393, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search product categories' names and handles." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2390 - ] - }, - { - "title": "Properties", - "children": [ - 2397, - 2398, - 2394, - 2396, - 2400, - 2399, - 2395, - 2393 - ] - } - ], - "extendedTypes": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - } - ] - }, - { - "id": 2407, - "name": "StoreGetProductTagsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved product tags." - } - ] - }, - "children": [ - { - "id": 2408, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2409, - "name": "new StoreGetProductTagsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2407, - "name": "StoreGetProductTagsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3970, - "name": "FindPaginationParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3969, - "name": "FindPaginationParams.constructor" - } - }, - { - "id": 2413, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply to the product tags' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 2416, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter product tags by the ID of their associated discount condition." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2410, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter product tags by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 2418, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": 3972, - "name": "FindPaginationParams.limit" - } - }, - { - "id": 2417, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", "inheritedFrom": { "type": "reference", "target": 3971, - "name": "FindPaginationParams.offset" + "name": "FindParams.constructor" } }, { - "id": 2415, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2411, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search product tags' values." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2414, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply to the product tags' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 2412, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Values to filter product tags by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2408 - ] - }, - { - "title": "Properties", - "children": [ - 2413, - 2416, - 2410, - 2418, - 2417, - 2415, - 2411, - 2414, - 2412 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3968, - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 2425, - "name": "StoreGetProductTypesParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved product types." - } - ] - }, - "children": [ - { - "id": 2426, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2427, - "name": "new StoreGetProductTypesParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2425, - "name": "StoreGetProductTypesParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3970, - "name": "FindPaginationParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3969, - "name": "FindPaginationParams.constructor" - } - }, - { - "id": 2431, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the product types' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 2434, - "name": "discount_condition_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter product types by the ID of their associated discount condition." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2428, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter product types by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 2436, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": 3972, - "name": "FindPaginationParams.limit" - } - }, - { - "id": 2435, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": 3971, - "name": "FindPaginationParams.offset" - } - }, - { - "id": 2433, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2429, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search product types' values." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2432, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the product types' " - }, - { - "kind": "code", - "text": "`updated_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 2430, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Values to filter product types by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2426 - ] - }, - { - "title": "Properties", - "children": [ - 2431, - 2434, - 2428, - 2436, - 2435, - 2433, - 2429, - 2432, - 2430 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3968, - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 2483, - "name": "StoreGetProductsPaginationParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters that can be used to configure how a list of data is paginated." - } - ] - }, - "children": [ - { - "id": 2484, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2485, - "name": "new StoreGetProductsPaginationParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2483, - "name": "StoreGetProductsPaginationParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4783, - "name": "PriceSelectionParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4782, - "name": "PriceSelectionParams.constructor" - } - }, - { - "id": 2489, - "name": "cart_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a cart ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4784, - "name": "PriceSelectionParams.cart_id" - } - }, - { - "id": 2491, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a currency code." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4786, - "name": "PriceSelectionParams.currency_code" - } - }, - { - "id": 2492, + "id": 276, "name": "expand", "variant": "declaration", "kind": 1024, @@ -68480,12 +8853,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 4787, - "name": "PriceSelectionParams.expand" + "target": 3973, + "name": "FindParams.expand" } }, { - "id": 2493, + "id": 277, "name": "fields", "variant": "declaration", "kind": 1024, @@ -68506,129 +8879,8 @@ }, "inheritedFrom": { "type": "reference", - "target": 4788, - "name": "PriceSelectionParams.fields" - } - }, - { - "id": 2487, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n100\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "100" - }, - { - "id": 2486, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 2488, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2490, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a region ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4785, - "name": "PriceSelectionParams.region_id" + "target": 3974, + "name": "FindParams.fields" } } ], @@ -68636,42 +8888,29 @@ { "title": "Constructors", "children": [ - 2484 + 274 ] }, { "title": "Properties", "children": [ - 2489, - 2491, - 2492, - 2493, - 2487, - 2486, - 2488, - 2490 + 276, + 277 ] } ], "extendedTypes": [ { "type": "reference", - "target": 4781, - "name": "PriceSelectionParams", + "target": 3970, + "name": "FindParams", "package": "@medusajs/medusa" } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2494, - "name": "StoreGetProductsParams" - } ] }, { - "id": 2494, - "name": "StoreGetProductsParams", + "id": 278, + "name": "AdminPostDiscountsDiscountDynamicCodesReq", "variant": "declaration", "kind": 128, "flags": {}, @@ -68679,828 +8918,71 @@ "summary": [ { "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved products." + "text": "The details of the dynamic discount to create." } ] }, "children": [ { - "id": 2495, + "id": 279, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2496, - "name": "new StoreGetProductsParams", + "id": 280, + "name": "new AdminPostDiscountsDiscountDynamicCodesReq", "variant": "signature", "kind": 16384, "flags": {}, - "type": { - "type": "reference", - "target": 2494, - "name": "StoreGetProductsParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 2485, - "name": "StoreGetProductsPaginationParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 2484, - "name": "StoreGetProductsPaginationParams.constructor" - } - }, - { - "id": 2514, - "name": "cart_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a cart ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2489, - "name": "StoreGetProductsPaginationParams.cart_id" - } - }, - { - "id": 2507, - "name": "category_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated product category's ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2499, - "name": "collection_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated product collection's ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2509, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the products' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 2516, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a currency code." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2491, - "name": "StoreGetProductsPaginationParams.currency_code" - } - }, - { - "id": 2502, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2517, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2492, - "name": "StoreGetProductsPaginationParams.expand" - } - }, - { - "id": 2518, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2493, - "name": "StoreGetProductsPaginationParams.fields" - } - }, - { - "id": 2503, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Handle to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2497, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter products by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 2508, - "name": "include_category_children", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether to include product category children in the response." - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ + "comment": { + "summary": [ { "kind": "text", - "text": "product_categories" + "text": "The details of the dynamic discount to create." } ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2504, - "name": "is_giftcard", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by whether they're gift cards." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 2512, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n100\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "100", - "inheritedFrom": { - "type": "reference", - "target": 2487, - "name": "StoreGetProductsPaginationParams.limit" - } - }, - { - "id": 2511, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { - "type": "reference", - "target": 2486, - "name": "StoreGetProductsPaginationParams.offset" - } - }, - { - "id": 2513, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2488, - "name": "StoreGetProductsPaginationParams.order" - } - }, - { - "id": 2498, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Search term to search products' title, description, variants' title and sku, and collections' title." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2515, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a region ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 2490, - "name": "StoreGetProductsPaginationParams.region_id" - } - }, - { - "id": 2506, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated sales channels' ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2500, - "name": "tags", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated tags' value." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2501, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Title to filter products by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2505, - "name": "type_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter products by their associated product type's ID." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 2510, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Date filters to apply on the products' " - }, - { - "kind": "code", - "text": "`created_at`" - }, - { - "kind": "text", - "text": " date." - } - ] - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2495 - ] - }, - { - "title": "Properties", - "children": [ - 2514, - 2507, - 2499, - 2509, - 2516, - 2502, - 2517, - 2518, - 2503, - 2497, - 2508, - 2504, - 2512, - 2511, - 2513, - 2498, - 2515, - 2506, - 2500, - 2501, - 2505, - 2510 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 2483, - "name": "StoreGetProductsPaginationParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 2539, - "name": "StoreGetRegionsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2540, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2541, - "name": "new StoreGetRegionsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 2542, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], "type": { "type": "reference", - "target": 2539, - "name": "StoreGetRegionsParams", + "target": 278, + "name": "AdminPostDiscountsDiscountDynamicCodesReq", "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).constructor" } } - ], - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).constructor" - } + ] }, { - "id": 2543, - "name": "created_at", + "id": 281, + "name": "code", "variant": "declaration", "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - } - }, - { - "id": 2545, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." + "text": "A unique code that will be used to redeem the Discount" } ] }, "type": { "type": "intrinsic", "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).expand" } }, { - "id": 2546, - "name": "fields", + "id": 282, + "name": "usage_limit", "variant": "declaration", "kind": 1024, - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).fields" - } - }, - { - "id": 2548, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n20\n```" - } - ] + "text": "Maximum number of times the discount code can be used" } ] }, @@ -69508,16 +8990,11 @@ "type": "intrinsic", "name": "number" }, - "defaultValue": "20", - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).limit" - } + "defaultValue": "1" }, { - "id": 2547, - "name": "offset", + "id": 283, + "name": "metadata", "variant": "declaration", "kind": 1024, "flags": { @@ -69527,45 +9004,28 @@ "summary": [ { "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] + "text": "An optional set of key-value pairs to hold additional information." } ] }, "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0", - "inheritedFrom": { "type": "reference", - "target": -1, - "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).offset" - } - }, - { - "id": 2544, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" } } ], @@ -69573,56 +9033,22 @@ { "title": "Constructors", "children": [ - 2540 + 279 ] }, { "title": "Properties", "children": [ - 2543, - 2545, - 2546, - 2548, - 2547, - 2544 - ] - } - ], - "extendedTypes": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "typeArguments": [ - { - "type": "intrinsic", - "name": "this" - } - ], - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } + 281, + 282, + 283 ] } ] }, { - "id": 2534, - "name": "StoreGetRegionsRegionParams", + "id": 284, + "name": "AdminDeleteDiscountsDiscountConditionsConditionParams", "variant": "declaration", "kind": 128, "flags": {}, @@ -69636,39 +9062,39 @@ }, "children": [ { - "id": 2535, + "id": 285, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2536, - "name": "new StoreGetRegionsRegionParams", + "id": 286, + "name": "new AdminDeleteDiscountsDiscountConditionsConditionParams", "variant": "signature", "kind": 16384, "flags": {}, "type": { "type": "reference", - "target": 2534, - "name": "StoreGetRegionsRegionParams", + "target": 284, + "name": "AdminDeleteDiscountsDiscountConditionsConditionParams", "package": "@medusajs/medusa" }, "inheritedFrom": { "type": "reference", - "target": 3965, + "target": 3972, "name": "FindParams.constructor" } } ], "inheritedFrom": { "type": "reference", - "target": 3964, + "target": 3971, "name": "FindParams.constructor" } }, { - "id": 2537, + "id": 287, "name": "expand", "variant": "declaration", "kind": 1024, @@ -69689,12 +9115,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 3966, + "target": 3973, "name": "FindParams.expand" } }, { - "id": 2538, + "id": 288, "name": "fields", "variant": "declaration", "kind": 1024, @@ -69715,7 +9141,7 @@ }, "inheritedFrom": { "type": "reference", - "target": 3967, + "target": 3974, "name": "FindParams.fields" } } @@ -69724,29 +9150,29 @@ { "title": "Constructors", "children": [ - 2535 + 285 ] }, { "title": "Properties", "children": [ - 2537, - 2538 + 287, + 288 ] } ], "extendedTypes": [ { "type": "reference", - "target": 3963, + "target": 3970, "name": "FindParams", "package": "@medusajs/medusa" } ] }, { - "id": 2572, - "name": "StoreGetShippingOptionsParams", + "id": 375, + "name": "AdminDeleteDiscountsDiscountConditionsConditionBatchParams", "variant": "declaration", "kind": 128, "flags": {}, @@ -69754,215 +9180,45 @@ "summary": [ { "kind": "text", - "text": "Filters to apply on the retrieved shipping options." + "text": "Parameters that can be used to configure how data is retrieved." } ] }, "children": [ { - "id": 2573, + "id": 376, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2574, - "name": "new StoreGetShippingOptionsParams", + "id": 377, + "name": "new AdminDeleteDiscountsDiscountConditionsConditionBatchParams", "variant": "signature", "kind": 16384, "flags": {}, "type": { "type": "reference", - "target": 2572, - "name": "StoreGetShippingOptionsParams", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2577, - "name": "is_return", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter the shipping options by whether they're return shipping options." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2575, - "name": "product_ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product ID that is used to filter shipping options by whether they can be used to ship that product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2576, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter the shipping options by the ID of their associated region." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2573 - ] - }, - { - "title": "Properties", - "children": [ - 2577, - 2575, - 2576 - ] - } - ] - }, - { - "id": 2607, - "name": "StoreGetVariantsParams", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Parameters used to filter and configure the pagination of the retrieved product variants." - } - ] - }, - "children": [ - { - "id": 2608, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2609, - "name": "new StoreGetVariantsParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2607, - "name": "StoreGetVariantsParams", + "target": 375, + "name": "AdminDeleteDiscountsDiscountConditionsConditionBatchParams", "package": "@medusajs/medusa" }, "inheritedFrom": { "type": "reference", - "target": 4783, - "name": "PriceSelectionParams.constructor" + "target": 3972, + "name": "FindParams.constructor" } } ], "inheritedFrom": { "type": "reference", - "target": 4782, - "name": "PriceSelectionParams.constructor" + "target": 3971, + "name": "FindParams.constructor" } }, { - "id": 2617, - "name": "cart_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a cart ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4784, - "name": "PriceSelectionParams.cart_id" - } - }, - { - "id": 2619, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a currency code." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4786, - "name": "PriceSelectionParams.currency_code" - } - }, - { - "id": 2620, + "id": 378, "name": "expand", "variant": "declaration", "kind": 1024, @@ -69983,12 +9239,12 @@ }, "inheritedFrom": { "type": "reference", - "target": 4787, - "name": "PriceSelectionParams.expand" + "target": 3973, + "name": "FindParams.expand" } }, { - "id": 2621, + "id": 379, "name": "fields", "variant": "declaration", "kind": 1024, @@ -70009,248 +9265,8 @@ }, "inheritedFrom": { "type": "reference", - "target": 4788, - "name": "PriceSelectionParams.fields" - } - }, - { - "id": 2614, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter product variants by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 2612, - "name": "ids", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID to filter the product variants by." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2616, - "name": "inventory_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Number filters to apply on the product variants' " - }, - { - "kind": "code", - "text": "`inventory_quantity`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "reference", - "target": 3928, - "name": "NumericalComparisonOperator", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 2610, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n100\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "100" - }, - { - "id": 2611, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ], - "blockTags": [ - { - "tag": "@defaultValue", - "content": [ - { - "kind": "code", - "text": "```ts\n0\n```" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "defaultValue": "0" - }, - { - "id": 2618, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a region ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4785, - "name": "PriceSelectionParams.region_id" - } - }, - { - "id": 2613, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter product variants by the ID of their associated sales channel." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2615, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Titles to filter product variants by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] + "target": 3974, + "name": "FindParams.fields" } } ], @@ -70258,39 +9274,29 @@ { "title": "Constructors", "children": [ - 2608 + 376 ] }, { "title": "Properties", "children": [ - 2617, - 2619, - 2620, - 2621, - 2614, - 2612, - 2616, - 2610, - 2611, - 2618, - 2613, - 2615 + 378, + 379 ] } ], "extendedTypes": [ { "type": "reference", - "target": 4781, - "name": "PriceSelectionParams", + "target": 3970, + "name": "FindParams", "package": "@medusajs/medusa" } ] }, { - "id": 2598, - "name": "StoreGetVariantsVariantParams", + "id": 380, + "name": "AdminDeleteDiscountsDiscountConditionsConditionBatchReq", "variant": "declaration", "kind": 128, "flags": {}, @@ -70298,240 +9304,21 @@ "summary": [ { "kind": "text", - "text": "The context to apply on retrieved prices." + "text": "The resources to remove." } ] }, "children": [ { - "id": 2599, + "id": 381, "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 2600, - "name": "new StoreGetVariantsVariantParams", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2598, - "name": "StoreGetVariantsVariantParams", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 4783, - "name": "PriceSelectionParams.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4782, - "name": "PriceSelectionParams.constructor" - } - }, - { - "id": 2602, - "name": "cart_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a cart ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4784, - "name": "PriceSelectionParams.cart_id" - } - }, - { - "id": 2604, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a currency code." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4786, - "name": "PriceSelectionParams.currency_code" - } - }, - { - "id": 2605, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated relations that should be expanded in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4787, - "name": "PriceSelectionParams.expand" - } - }, - { - "id": 2606, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Comma-separated fields that should be included in the returned data." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4788, - "name": "PriceSelectionParams.fields" - } - }, - { - "id": 2603, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve prices for a region ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 4785, - "name": "PriceSelectionParams.region_id" - } - }, - { - "id": 2601, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2599 - ] - }, - { - "title": "Properties", - "children": [ - 2602, - 2604, - 2605, - 2606, - 2603, - 2601 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4781, - "name": "PriceSelectionParams", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 2367, - "name": "StorePaymentCollectionSessionsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the payment session to manage." - } - ] - }, - "children": [ - { - "id": 2368, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2369, - "name": "new StorePaymentCollectionSessionsReq", + "id": 382, + "name": "new AdminDeleteDiscountsDiscountConditionsConditionBatchReq", "variant": "signature", "kind": 16384, "flags": {}, @@ -70539,22 +9326,22 @@ "summary": [ { "kind": "text", - "text": "The details of the payment session to manage." + "text": "The resources to remove." } ] }, "type": { "type": "reference", - "target": 2367, - "name": "StorePaymentCollectionSessionsReq", + "target": 380, + "name": "AdminDeleteDiscountsDiscountConditionsConditionBatchReq", "package": "@medusajs/medusa" } } ] }, { - "id": 2370, - "name": "provider_id", + "id": 383, + "name": "resources", "variant": "declaration", "kind": 1024, "flags": {}, @@ -70562,10887 +9349,35 @@ "summary": [ { "kind": "text", - "text": "The ID of the Payment Provider." + "text": "The resources to be removed from the discount condition" } ] }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2368 - ] - }, - { - "title": "Properties", - "children": [ - 2370 - ] - } - ] - }, - { - "id": 2121, - "name": "StorePostAuthReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2122, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2123, - "name": "new StorePostAuthReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2121, - "name": "StorePostAuthReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2124, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Customer's email." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2125, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Customer's password." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2122 - ] - }, - { - "title": "Properties", - "children": [ - 2124, - 2125 - ] - } - ] - }, - { - "id": 2151, - "name": "StorePostCartReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the cart to be created." - } - ] - }, - "children": [ - { - "id": 2152, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2153, - "name": "new StorePostCartReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the cart to be created." - } - ] - }, - "type": { - "type": "reference", - "target": 2151, - "name": "StorePostCartReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2157, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object to provide context to the Cart. The `context` field is automatically populated with `ip` and `user_agent`" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 2155, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The two character ISO country code to create the Cart in. Setting this parameter will set the country code of the shipping address." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2156, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product variants to generate line items from." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2146, - "name": "Item", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 2154, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Region to create the Cart in. Setting the cart's region can affect the pricing of the items in the cart as well as the used currency. If this parameter is not provided, the first region in the store is used by default." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2158, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Sales channel to create the Cart in. The cart's sales channel affects which products can be added to the cart. If a product does not exist in the cart's sales channel, it cannot be added to the cart. If you add a publishable API key in the header of this request and specify a sales channel ID, the specified sales channel must be within the scope of the publishable API key's resources. If you add a publishable API key in the header of this request, you don't specify a sales channel ID, and the publishable API key is associated with one sales channel, that sales channel will be attached to the cart. If no sales channel is passed and no publishable API key header is passed or the publishable API key isn't associated with any sales channel, the cart will not be associated with any sales channel." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2152 - ] - }, - { - "title": "Properties", - "children": [ - 2157, - 2155, - 2156, - 2154, - 2158 - ] - } - ] - }, - { - "id": 2182, - "name": "StorePostCartsCartLineItemsItemReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the line item." - } - ] - }, - "children": [ - { - "id": 2183, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2184, - "name": "new StorePostCartsCartLineItemsItemReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the line item." - } - ] - }, - "type": { - "type": "reference", - "target": 2182, - "name": "StorePostCartsCartLineItemsItemReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2186, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional key-value map with additional details about the Line Item. If omitted, the metadata will remain unchanged.\"" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2185, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity of the line item in the cart." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2183 - ] - }, - { - "title": "Properties", - "children": [ - 2186, - 2185 - ] - } - ] - }, - { - "id": 2159, - "name": "StorePostCartsCartLineItemsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the line item to create." - } - ] - }, - "children": [ - { - "id": 2160, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2161, - "name": "new StorePostCartsCartLineItemsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the line item to create." - } - ] - }, - "type": { - "type": "reference", - "target": 2159, - "name": "StorePostCartsCartLineItemsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2164, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional key-value map with additional details about the Line Item." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2163, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The quantity of the Product Variant to add to the Line Item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2162, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The id of the Product Variant to generate the Line Item from." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2160 - ] - }, - { - "title": "Properties", - "children": [ - 2164, - 2163, - 2162 - ] - } - ] - }, - { - "id": 2165, - "name": "StorePostCartsCartPaymentSessionReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the payment session to set." - } - ] - }, - "children": [ - { - "id": 2166, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2167, - "name": "new StorePostCartsCartPaymentSessionReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the payment session to set." - } - ] - }, - "type": { - "type": "reference", - "target": 2165, - "name": "StorePostCartsCartPaymentSessionReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2168, - "name": "provider_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Payment Provider." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2166 - ] - }, - { - "title": "Properties", - "children": [ - 2168 - ] - } - ] - }, - { - "id": 2187, - "name": "StorePostCartsCartPaymentSessionUpdateReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2188, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2189, - "name": "new StorePostCartsCartPaymentSessionUpdateReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2187, - "name": "StorePostCartsCartPaymentSessionUpdateReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2190, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data to update the payment session with." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2188 - ] - }, - { - "title": "Properties", - "children": [ - 2190 - ] - } - ] - }, - { - "id": 2169, - "name": "StorePostCartsCartReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the cart." - } - ] - }, - "children": [ - { - "id": 2170, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2171, - "name": "new StorePostCartsCartReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the cart." - } - ] - }, - "type": { - "type": "reference", - "target": 2169, - "name": "StorePostCartsCartReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2175, - "name": "billing_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Address to be used for billing purposes." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 3935, - "name": "AddressPayload", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 2180, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object to provide context to the Cart. The `context` field is automatically populated with `ip` and `user_agent`" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 2173, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The 2 character ISO country code to create the Cart in. Setting this parameter will set the country code of the shipping address." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2179, - "name": "customer_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Customer to associate the Cart with." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2178, - "name": "discounts", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of Discount codes to add to the Cart." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4777, - "name": "Discount", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 2174, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An email to be used on the Cart." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2177, - "name": "gift_cards", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of Gift Card codes to add to the Cart." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4773, - "name": "GiftCard", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 2172, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Region to create the Cart in. Setting the cart's region can affect the pricing of the items in the cart as well as the used currency." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2181, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Sales channel to create the Cart in. The cart's sales channel affects which products can be added to the cart. If a product does not exist in the cart's sales channel, it cannot be added to the cart. If you add a publishable API key in the header of this request and specify a sales channel ID, the specified sales channel must be within the scope of the publishable API key's resources." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2176, - "name": "shipping_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Address to be used for shipping purposes." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 3935, - "name": "AddressPayload", - "package": "@medusajs/medusa" - } - ] - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2170 - ] - }, - { - "title": "Properties", - "children": [ - 2175, - 2180, - 2173, - 2179, - 2178, - 2174, - 2177, - 2172, - 2181, - 2176 - ] - } - ] - }, - { - "id": 2141, - "name": "StorePostCartsCartShippingMethodReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the shipping method to add to the cart." - } - ] - }, - "children": [ - { - "id": 2142, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2143, - "name": "new StorePostCartsCartShippingMethodReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the shipping method to add to the cart." - } - ] - }, - "type": { - "type": "reference", - "target": 2141, - "name": "StorePostCartsCartShippingMethodReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2145, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to hold any data that the shipping method may need to process the fulfillment of the order. This depends on the fulfillment provider you're using." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - }, - "defaultValue": "{}" - }, - { - "id": 2144, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "ID of the shipping option to create the method from." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2142 - ] - }, - { - "title": "Properties", - "children": [ - 2145, - 2144 - ] - } - ] - }, - { - "id": 2321, - "name": "StorePostCustomersCustomerAcceptClaimReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details necessary to grant order access." - } - ] - }, - "children": [ - { - "id": 2322, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2323, - "name": "new StorePostCustomersCustomerAcceptClaimReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details necessary to grant order access." - } - ] - }, - "type": { - "type": "reference", - "target": 2321, - "name": "StorePostCustomersCustomerAcceptClaimReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2324, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The claim token generated by previous request to the Claim Order API Route." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2322 - ] - }, - { - "title": "Properties", - "children": [ - 2324 - ] - } - ] - }, - { - "id": 2276, - "name": "StorePostCustomersCustomerAddressesAddressReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2277, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2278, - "name": "new StorePostCustomersCustomerAddressesAddressReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2276, - "name": "StorePostCustomersCustomerAddressesAddressReq", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": 3937, - "name": "AddressPayload.constructor" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3936, - "name": "AddressPayload.constructor" - } - }, - { - "id": 2284, - "name": "address_1", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Address line 1" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3943, - "name": "AddressPayload.address_1" - } - }, - { - "id": 2285, - "name": "address_2", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Address line 2" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3944, - "name": "AddressPayload.address_2" - } - }, - { - "id": 2286, - "name": "city", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "City" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3945, - "name": "AddressPayload.city" - } - }, - { - "id": 2283, - "name": "company", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Company" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3942, - "name": "AddressPayload.company" - } - }, - { - "id": 2287, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The 2 character ISO code of the country in lower case" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3946, - "name": "AddressPayload.country_code" - } - }, - { - "id": 2279, - "name": "first_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "First name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3938, - "name": "AddressPayload.first_name" - } - }, - { - "id": 2280, - "name": "last_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Last name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3939, - "name": "AddressPayload.last_name" - } - }, - { - "id": 2282, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional key-value map with additional details" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3941, - "name": "AddressPayload.metadata" - } - }, - { - "id": 2281, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Phone Number" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3940, - "name": "AddressPayload.phone" - } - }, - { - "id": 2289, - "name": "postal_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Postal Code" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3948, - "name": "AddressPayload.postal_code" - } - }, - { - "id": 2288, - "name": "province", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Province" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 3947, - "name": "AddressPayload.province" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2277 - ] - }, - { - "title": "Properties", - "children": [ - 2284, - 2285, - 2286, - 2283, - 2287, - 2279, - 2280, - 2282, - 2281, - 2289, - 2288 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3935, - "name": "AddressPayload", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 2226, - "name": "StorePostCustomersCustomerAddressesReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2227, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2228, - "name": "new StorePostCustomersCustomerAddressesReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2226, - "name": "StorePostCustomersCustomerAddressesReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2229, - "name": "address", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Address to add to the Customer's saved addresses." - } - ] - }, - "type": { - "type": "reference", - "target": 3949, - "name": "AddressCreatePayload", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2227 - ] - }, - { - "title": "Properties", - "children": [ - 2229 - ] - } - ] - }, - { - "id": 2337, - "name": "StorePostCustomersCustomerOrderClaimReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the orders to claim." - } - ] - }, - "children": [ - { - "id": 2338, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2339, - "name": "new StorePostCustomersCustomerOrderClaimReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the orders to claim." - } - ] - }, - "type": { - "type": "reference", - "target": 2337, - "name": "StorePostCustomersCustomerOrderClaimReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2340, - "name": "order_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the orders to claim" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2338 - ] - }, - { - "title": "Properties", - "children": [ - 2340 - ] - } - ] - }, - { - "id": 2272, - "name": "StorePostCustomersCustomerPasswordTokenReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2273, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2274, - "name": "new StorePostCustomersCustomerPasswordTokenReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2272, - "name": "StorePostCustomersCustomerPasswordTokenReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2275, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's email." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2273 - ] - }, - { - "title": "Properties", - "children": [ - 2275 - ] - } - ] - }, - { - "id": 2290, - "name": "StorePostCustomersCustomerReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the customer." - } - ] - }, - "children": [ - { - "id": 2291, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2292, - "name": "new StorePostCustomersCustomerReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details to update of the customer." - } - ] - }, - "type": { - "type": "reference", - "target": 2290, - "name": "StorePostCustomersCustomerReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2293, - "name": "billing_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The address to be used for billing purposes." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 3935, - "name": "AddressPayload", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 2298, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's email." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2294, - "name": "first_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's first name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2295, - "name": "last_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's last name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2299, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Additional custom data about the customer." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2296, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's password." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2297, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's phone number." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2291 - ] - }, - { - "title": "Properties", - "children": [ - 2293, - 2298, - 2294, - 2295, - 2299, - 2296, - 2297 - ] - } - ] - }, - { - "id": 2230, - "name": "StorePostCustomersReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the customer to create." - } - ] - }, - "children": [ - { - "id": 2231, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2232, - "name": "new StorePostCustomersReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the customer to create." - } - ] - }, - "type": { - "type": "reference", - "target": 2230, - "name": "StorePostCustomersReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2235, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's email." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2233, - "name": "first_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's first name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2234, - "name": "last_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's last name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2236, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's password." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2237, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's phone number." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2231 - ] - }, - { - "title": "Properties", - "children": [ - 2235, - 2233, - 2234, - 2236, - 2237 - ] - } - ] - }, - { - "id": 2266, - "name": "StorePostCustomersResetPasswordReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2267, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2268, - "name": "new StorePostCustomersResetPasswordReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2266, - "name": "StorePostCustomersResetPasswordReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2269, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's email." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2271, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's password." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2270, - "name": "token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The reset password token" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2267 - ] - }, - { - "title": "Properties", - "children": [ - 2269, - 2271, - 2270 - ] - } - ] - }, - { - "id": 2310, - "name": "StorePostOrderEditsOrderEditDecline", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the order edit's decline." - } - ] - }, - "children": [ - { - "id": 2311, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2312, - "name": "new StorePostOrderEditsOrderEditDecline", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the order edit's decline." - } - ] - }, - "type": { - "type": "reference", - "target": 2310, - "name": "StorePostOrderEditsOrderEditDecline", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2313, - "name": "declined_reason", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The reason for declining the Order Edit." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2311 - ] - }, - { - "title": "Properties", - "children": [ - 2313 - ] - } - ] - }, - { - "id": 2348, - "name": "StorePostPaymentCollectionsBatchSessionsAuthorizeReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the payment sessions to authorize." - } - ] - }, - "children": [ - { - "id": 2349, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2350, - "name": "new StorePostPaymentCollectionsBatchSessionsAuthorizeReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the payment sessions to authorize." - } - ] - }, - "type": { - "type": "reference", - "target": 2348, - "name": "StorePostPaymentCollectionsBatchSessionsAuthorizeReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2351, - "name": "session_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of Payment Session IDs to authorize." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2349 - ] - }, - { - "title": "Properties", - "children": [ - 2351 - ] - } - ] - }, - { - "id": 2363, - "name": "StorePostPaymentCollectionsBatchSessionsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the payment sessions to manage." - } - ] - }, - "children": [ - { - "id": 2364, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2365, - "name": "new StorePostPaymentCollectionsBatchSessionsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the payment sessions to manage." - } - ] - }, - "type": { - "type": "reference", - "target": 2363, - "name": "StorePostPaymentCollectionsBatchSessionsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2366, - "name": "sessions", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payment sessions related to the Payment Collection. Existing sessions that are not added in this array will be deleted." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2357, - "name": "StorePostPaymentCollectionsSessionsReq", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2364 - ] - }, - { - "title": "Properties", - "children": [ - 2366 - ] - } - ] - }, - { - "id": 2357, - "name": "StorePostPaymentCollectionsSessionsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2358, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2359, - "name": "new StorePostPaymentCollectionsSessionsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2357, - "name": "StorePostPaymentCollectionsSessionsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2361, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The payment amount" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2360, - "name": "provider_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Payment Provider." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2362, - "name": "session_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Payment Session to be updated. If no ID is provided, a new payment session is created." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2358 - ] - }, - { - "title": "Properties", - "children": [ - 2361, - 2360, - 2362 - ] - } - ] - }, - { - "id": 2560, - "name": "StorePostReturnsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the return to create." - } - ] - }, - "children": [ - { - "id": 2561, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2562, - "name": "new StorePostReturnsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the return to create." - } - ] - }, - "type": { - "type": "reference", - "target": 2560, - "name": "StorePostReturnsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2564, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The items to include in the return." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4789, - "name": "Item", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 2563, - "name": "order_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Order to create the return for." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2565, - "name": "return_shipping", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The return shipping method used to return the items. If provided, a fulfillment is automatically created for the return." - } - ] - }, - "type": { - "type": "reference", - "target": 4796, - "name": "ReturnShipping", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2561 - ] - }, - { - "title": "Properties", - "children": [ - 2564, - 2563, - 2565 - ] - } - ] - }, - { - "id": 2519, - "name": "StorePostSearchReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 2520, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2521, - "name": "new StorePostSearchReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 2519, - "name": "StorePostSearchReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2525, - "name": "filter", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pass filters based on the search service." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 2524, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of products returned." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2523, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of products to skip when retrieving the products." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2522, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The search query." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2520 - ] - }, - { - "title": "Properties", - "children": [ - 2525, - 2524, - 2523, - 2522 - ] - } - ] - }, - { - "id": 2583, - "name": "StorePostSwapsReq", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the swap to create." - } - ] - }, - "children": [ - { - "id": 2584, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 2585, - "name": "new StorePostSwapsReq", - "variant": "signature", - "kind": 16384, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the swap to create." - } - ] - }, - "type": { - "type": "reference", - "target": 2583, - "name": "StorePostSwapsReq", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 2588, - "name": "additional_items", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The items to exchange the returned items with." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4808, - "name": "AdditionalItem", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 2586, - "name": "order_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Order to create the Swap for." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2587, - "name": "return_items", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The items to include in the Return." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4801, - "name": "Item", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 2589, - "name": "return_shipping_option", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Shipping Option to create the Shipping Method from." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 2584 - ] - }, - { - "title": "Properties", - "children": [ - 2588, - 2586, - 2587, - 2589 - ] - } - ] - }, - { - "id": 3918, - "name": "StringComparisonOperator", - "variant": "declaration", - "kind": 128, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fields used to apply flexible filters on strings." - } - ] - }, - "children": [ - { - "id": 3919, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 3920, - "name": "new StringComparisonOperator", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 3925, - "name": "contains", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered string must contain this value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3927, - "name": "ends_with", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered string must end with this value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3922, - "name": "gt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered string must be greater than this value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3923, - "name": "gte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered string must be greater than or equal to this value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3921, - "name": "lt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered string must be less than this value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3924, - "name": "lte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered string must be less than or equal to this value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3926, - "name": "starts_with", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The filtered string must start with this value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3919 - ] - }, - { - "title": "Properties", - "children": [ - 3925, - 3927, - 3922, - 3923, - 3921, - 3924, - 3926 - ] - } - ] - }, - { - "id": 5012, - "name": "Tag", - "variant": "declaration", - "kind": 128, - "flags": {}, - "children": [ - { - "id": 5013, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, - "signatures": [ - { - "id": 5014, - "name": "new Tag", - "variant": "signature", - "kind": 16384, - "flags": {}, - "type": { - "type": "reference", - "target": 5012, - "name": "Tag", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 5015, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5016, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tag value" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 5013 - ] - }, - { - "title": "Properties", - "children": [ - 5015, - 5016 - ] - } - ] - }, - { - "id": 3760, - "name": "TransactionBaseService", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 3761, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3762, - "name": "new TransactionBaseService", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 3763, - "name": "__container__", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3764, - "name": "__configModule__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3765, - "name": "__moduleDeclaration__", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 3771, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3770, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3772, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3766, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - }, - { - "id": 3767, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - ] - } - }, - { - "id": 3768, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 3769, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - }, - { - "id": 3781, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3782, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 3783, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 3784, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 3785, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3786, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3787, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3788, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 3789, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 3790, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3791, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3792, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3793, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3794, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3795, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3796, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3776, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3777, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3778, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 3779, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3780, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3780 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 3773, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3774, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3775, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 3761 - ] - }, - { - "title": "Properties", - "children": [ - 3771, - 3770, - 3772, - 3766, - 3767 - ] - }, - { - "title": "Accessors", - "children": [ - 3768 - ] - }, - { - "title": "Methods", - "children": [ - 3781, - 3776, - 3773 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 2704, - "name": "IBatchJobStrategy" - }, - { - "type": "reference", - "target": 2748, - "name": "AbstractBatchJobStrategy" - }, - { - "type": "reference", - "target": 2824, - "name": "AbstractCartCompletionStrategy" - }, - { - "type": "reference", - "target": 2870, - "name": "IFileService" - }, - { - "type": "reference", - "target": 2920, - "name": "AbstractFileService" - }, - { - "type": "reference", - "target": 2979, - "name": "FulfillmentService" - }, - { - "type": "reference", - "target": 3056, - "name": "AbstractFulfillmentService" - }, - { - "type": "reference", - "target": 3144, - "name": "INotificationService" - }, - { - "type": "reference", - "target": 3186, - "name": "AbstractNotificationService" - }, - { - "type": "reference", - "target": 3374, - "name": "PaymentService" - }, - { - "type": "reference", - "target": 3456, - "name": "AbstractPaymentService" - }, - { - "type": "reference", - "target": 3561, - "name": "AbstractPriceSelectionStrategy" - }, - { - "type": "reference", - "target": 3643, - "name": "AbstractTaxCalculationStrategy" - }, - { - "type": "reference", - "target": 3711, - "name": "AbstractTaxService" - } - ] - }, - { - "id": 3877, - "name": "CustomFindOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3880, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/OrderByCondition.d.ts", - "qualifiedName": "OrderByCondition" - }, - "name": "OrderByCondition", - "package": "typeorm" - } - }, - { - "id": 3878, - "name": "select", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsSelect.d.ts", - "qualifiedName": "FindOptionsSelect" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3883, - "name": "TModel", - "package": "@medusajs/medusa", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsSelect", - "package": "typeorm" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsSelect.d.ts", - "qualifiedName": "FindOptionsSelectByString" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3883, - "name": "TModel", - "package": "@medusajs/medusa", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsSelectByString", - "package": "typeorm" - } - ] - } - }, - { - "id": 3881, - "name": "skip", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3882, - "name": "take", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3879, - "name": "where", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", - "qualifiedName": "FindOptionsWhere" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3883, - "name": "TModel", - "package": "@medusajs/medusa", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsWhere", - "package": "typeorm" - }, - { - "type": "mapped", - "parameter": "P", - "parameterType": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - }, - "templateType": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "P" - }, - "name": "P", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 3883, - "name": "TModel", - "package": "@medusajs/medusa", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - } - }, - "optionalModifier": "+" - } - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", - "qualifiedName": "FindOptionsWhere" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3883, - "name": "TModel", - "package": "@medusajs/medusa", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsWhere", - "package": "typeorm" - } - }, - { - "type": "mapped", - "parameter": "P", - "parameterType": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - }, - "templateType": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "P" - }, - "name": "P", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 3883, - "name": "TModel", - "package": "@medusajs/medusa", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - } - }, - "optionalModifier": "+" - } - ] - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3880, - 3878, - 3881, - 3882, - 3879 - ] - } - ], - "typeParameters": [ - { - "id": 3883, - "name": "TModel", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 3884, - "name": "InKeys", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 3883, - "name": "TModel", - "package": "@medusajs/medusa", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - } - } - ] - }, - { - "id": 3904, - "name": "DeleteResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The response returned for a " - }, - { - "kind": "code", - "text": "`DELETE`" - }, - { - "kind": "text", - "text": " request." - } - ] - }, - "children": [ - { - "id": 3907, - "name": "deleted", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the item was deleted successfully." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": true - }, - { - "id": 3905, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the deleted item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3906, - "name": "object", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the deleted item." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "product-collection" - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3907, - 3905, - 3906 - ] - } - ] - }, - { - "id": 3847, - "name": "FindConfig", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3852, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3853, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "indexSignature": { - "id": 3854, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 3855, - "name": "K", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ASC" - }, - { - "type": "literal", - "value": "DESC" - } - ] - } - } - } - } - }, - { - "id": 3851, - "name": "relations", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 3848, - "name": "select", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 3856, - "name": "Entity", - "package": "@medusajs/medusa", - "qualifiedName": "FindConfig.Entity", - "refersToTypeParameter": true - } - } - } - }, - { - "id": 3849, - "name": "skip", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3850, - "name": "take", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3852, - 3851, - 3848, - 3849, - 3850 - ] - } - ], - "typeParameters": [ - { - "id": 3856, - "name": "Entity", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ] - }, - { - "id": 2979, - "name": "FulfillmentService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "## Overview\n\nA fulfillment provider is the shipping provider used to fulfill orders and deliver them to customers. An example of a fulfillment provider is FedEx.\n\nBy default, a Medusa Backend has a " - }, - { - "kind": "code", - "text": "`manual`" - }, - { - "kind": "text", - "text": " fulfillment provider which has minimal implementation. It allows you to accept orders and fulfill them manually. However, you can integrate any fulfillment provider into Medusa, and your fulfillment provider can interact with third-party shipping providers.\n\nA fulfillment provider is a service that extends the " - }, - { - "kind": "code", - "text": "`AbstractFulfillmentService`" - }, - { - "kind": "text", - "text": " and implements its methods. So, adding a fulfillment provider is as simple as creating a service file in " - }, - { - "kind": "code", - "text": "`src/services`" - }, - { - "kind": "text", - "text": ".\nThe file's name is the fulfillment provider's class name as a slug and without the word " - }, - { - "kind": "code", - "text": "`Service`" - }, - { - "kind": "text", - "text": ". For example, if you're creating a " - }, - { - "kind": "code", - "text": "`MyFulfillmentService`" - }, - { - "kind": "text", - "text": " class, the file name is " - }, - { - "kind": "code", - "text": "`src/services/my-fulfillment.ts`" - }, - { - "kind": "text", - "text": ".\n\n" - }, - { - "kind": "code", - "text": "```ts title=src/services/my-fulfillment.ts\nimport { AbstractFulfillmentService } from \"@medusajs/medusa\"\n\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // methods here...\n}\n\nexport default MyFulfillmentService\n```" - }, - { - "kind": "text", - "text": "\n\n---\n\n## Identifier Property\n\nThe " - }, - { - "kind": "code", - "text": "`FulfillmentProvider`" - }, - { - "kind": "text", - "text": " entity has 2 properties: " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`is_installed`" - }, - { - "kind": "text", - "text": ". The " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " property in the fulfillment provider service is used when the fulfillment provider is added to the database.\n\nThe value of this property is also used to reference the fulfillment provider throughout Medusa. For example, it is used to [add a fulfillment provider](https://docs.medusajs.com/api/admin#regions_postregionsregionfulfillmentproviders) to a region.\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n static identifier = \"my-fulfillment\"\n\n // ...\n}\n```" - }, - { - "kind": "text", - "text": "\n\n---" - } - ] - }, - "children": [ - { - "id": 3030, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - } - }, - { - "id": 3029, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - } - }, - { - "id": 3031, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - } - }, - { - "id": 3025, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - } - }, - { - "id": 3026, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - } - }, - { - "id": 3027, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 3028, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - } - }, - { - "id": 3040, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3041, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 3042, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 3043, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 3044, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3045, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3046, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3047, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 3048, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 3049, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3050, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3051, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3052, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3053, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3054, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3055, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - } - }, - { - "id": 2995, - "name": "calculatePrice", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2996, - "name": "calculatePrice", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used in different places, including:\n\n1. When the shipping options for a cart are retrieved during checkout. If a shipping option has their " - }, - { - "kind": "code", - "text": "`price_type`" - }, - { - "kind": "text", - "text": " set to calculated, this method is used to set the amount of the returned shipping option.\n2. When a shipping method is created. If the shipping option associated with the method has their " - }, - { - "kind": "code", - "text": "`price_type`" - }, - { - "kind": "text", - "text": " set to " - }, - { - "kind": "code", - "text": "`calculated`" - }, - { - "kind": "text", - "text": ", this method is used to set the " - }, - { - "kind": "code", - "text": "`price`" - }, - { - "kind": "text", - "text": " attribute of the shipping method in the database.\n3. When the cart's totals are calculated." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Used to set the price of the shipping method or option, based on the context the method is used in." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "text", - "text": "An example of calculating the price based on some custom logic:\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async calculatePrice(\n optionData: Record,\n data: Record,\n cart: Cart\n ): Promise {\n return cart.items.length * 1000\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\nIf your fulfillment provider does not provide any dynamically calculated rates you can return any static value or throw an error. For example:\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async calculatePrice(\n optionData: Record,\n data: Record,\n cart: Cart\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 2997, - "name": "optionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object of the selected shipping option." - } - ] - }, - "type": { - "type": "reference", - "target": 4874, - "name": "ShippingOptionData", - "package": "@medusajs/medusa" - } - }, - { - "id": 2998, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object that is different based on the context it's used in:\n\n1. If the price is being calculated for the list of shipping options available for a cart, it's the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object of the shipping option.\n2. If the price is being calculated when the shipping method is being created, it's the data returned by the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "validateFulfillmentData", - "target": 2984, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " method used during the shipping method creation.\n3. If the price is being calculated while calculating the cart's totals, it will be the data object of the cart's shipping method." - } - ] - }, - "type": { - "type": "reference", - "target": 4875, - "name": "FulfillmentProviderData", - "package": "@medusajs/medusa" - } - }, - { - "id": 2999, - "name": "cart", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Either the Cart or the Order object." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "number" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2992, - "name": "canCalculate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2993, - "name": "canCalculate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to determine whether a shipping option is calculated dynamically or flat rate. It is called if the " - }, - { - "kind": "code", - "text": "`price_type`" - }, - { - "kind": "text", - "text": " of the shipping option being created is set to calculated." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "If this method returns " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ", that means that the price can be calculated dynamically and the shipping option can have the " - }, - { - "kind": "code", - "text": "`price_type`" - }, - { - "kind": "text", - "text": " set to calculated.\nThe amount property of the shipping option will then be set to null. The amount will be created later when the shipping method is created on checkout using the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "calculatePrice", - "target": 2995, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " method.\nIf the method returns " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": ", an error is thrown as it means the selected shipping option is invalid and it can only have the " - }, - { - "kind": "code", - "text": "`flat_rate`" - }, - { - "kind": "text", - "text": " price type." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async canCalculate(\n data: Record\n ): Promise {\n return data.id === \"my-fulfillment-dynamic\"\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 2994, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object of the shipping option being created. You can use this data to determine whether the shipping option should be calculated or not.\nThis is useful if the fulfillment provider you are integrating has both flat rate and dynamically priced fulfillment options." - } - ] - }, - "type": { - "type": "reference", - "target": 4874, - "name": "ShippingOptionData", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "boolean" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3006, - "name": "cancelFulfillment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3007, - "name": "cancelFulfillment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is called when a fulfillment is cancelled by the admin. This fulfillment can be for an order, a claim, or a swap." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The method isn't expected to return any specific data." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "text", - "text": "This is the basic implementation of the method for a fulfillment provider that doesn't interact with a third-party provider to cancel the fulfillment:\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async cancelFulfillment(\n fulfillment: Record\n ): Promise {\n return {}\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3008, - "name": "fulfillmentData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " attribute of the fulfillment being canceled" - } - ] - }, - "type": { - "type": "reference", - "target": 4875, - "name": "FulfillmentProviderData", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3000, - "name": "createFulfillment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3001, - "name": "createFulfillment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used when a fulfillment is created for an order, a claim, or a swap." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The data that will be stored in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " attribute of the created fulfillment." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "text", - "text": "Here is a basic implementation of " - }, - { - "kind": "code", - "text": "`createFulfillment`" - }, - { - "kind": "text", - "text": " for a fulfillment provider that does not interact with any third-party provider to create the fulfillment:\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async createFulfillment(\n data: Record,\n items: LineItem,\n order: Order,\n fulfillment: Fulfillment\n ) {\n // No data is being sent anywhere\n // No data to be stored in the fulfillment's data object\n return {}\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3002, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object of the shipping method associated with the resource, such as the order.\nYou can use it to access the data specific to the shipping option. This is based on your implementation of previous methods." - } - ] - }, - "type": { - "type": "reference", - "target": 4876, - "name": "ShippingMethodData", - "package": "@medusajs/medusa" - } - }, - { - "id": 3003, - "name": "items", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The line items in the order to be fulfilled. The admin can choose all or some of the items to fulfill." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", - "qualifiedName": "LineItem" - }, - "name": "LineItem", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 3004, - "name": "order", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the created resource, which is either an order, a claim, or a swap:\n- If the resource the fulfillment is being created for is a claim, the " - }, - { - "kind": "code", - "text": "`is_claim`" - }, - { - "kind": "text", - "text": " property in the object will be " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ".\n- If the resource the fulfillment is being created for is a swap, the " - }, - { - "kind": "code", - "text": "`is_swap`" - }, - { - "kind": "text", - "text": " property in the object will be " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": ".\n- Otherwise, the resource is an order." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "Order" - }, - "name": "Order", - "package": "@medusajs/medusa" - } - }, - { - "id": 3005, - "name": "fulfillment", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The fulfillment being created." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/fulfillment.ts", - "qualifiedName": "Fulfillment" - }, - "name": "Fulfillment", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4875, - "name": "FulfillmentProviderData", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3009, - "name": "createReturn", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3010, - "name": "createReturn", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Fulfillment providers can also be used to return products. A shipping option can be used for returns if the " - }, - { - "kind": "code", - "text": "`is_return`" - }, - { - "kind": "text", - "text": " property is true or if an admin creates a Return Shipping Option from the settings.\nThis method is used when the admin [creates a return request](https://docs.medusajs.com/api/admin#orders_postordersorderreturns) for an order,\n[creates a swap](https://docs.medusajs.com/api/admin#orders_postordersorderswaps) for an order, or when the\n[customer creates a return of their order](https://docs.medusajs.com/api/store#returns_postreturns). The fulfillment is created automatically for the order return." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Used to set the value of the " - }, - { - "kind": "code", - "text": "`shipping_data`" - }, - { - "kind": "text", - "text": " attribute of the return being created." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "text", - "text": "This is the basic implementation of the method for a fulfillment provider that does not contact with a third-party provider to fulfill the return:\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async createReturn(\n returnOrder: CreateReturnType\n ): Promise> {\n return {}\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3011, - "name": "returnOrder", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the return that the fulfillment is being created for." - } - ] - }, - "type": { - "type": "reference", - "target": 4877, - "name": "CreateReturnType", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3012, - "name": "getFulfillmentDocuments", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3013, - "name": "getFulfillmentDocuments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to retrieve any documents associated with a fulfillment. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async getFulfillmentDocuments(\n data: Record\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getFulfillmentDocuments()\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3014, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " attribute of the fulfillment that you're retrieving the documents for." - } - ] - }, - "type": { - "type": "reference", - "target": 4875, - "name": "FulfillmentProviderData", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2982, - "name": "getFulfillmentOptions", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2983, - "name": "getFulfillmentOptions", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used when retrieving the list of fulfillment options available in a region, particularly by the [List Fulfillment Options API Route](https://docs.medusajs.com/api/admin#regions_getregionsregionfulfillmentoptions).\nFor example, if you’re integrating UPS as a fulfillment provider, you might support two fulfillment options: UPS Express Shipping and UPS Access Point. Each of these options can have different data associated with them." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The list of fulfillment options. These options don't have any required format. Later on, these options can be used when creating a shipping option,\nsuch as when using the [Create Shipping Option API Route](https://docs.medusajs.com/api/admin#shipping-options_postshippingoptions). The chosen fulfillment option, which is one of the\nitems in the array returned by this method, will be set in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object of the shipping option." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async getFulfillmentOptions(): Promise {\n return [\n {\n id: \"my-fulfillment\",\n },\n {\n id: \"my-fulfillment-dynamic\",\n },\n ]\n }\n}\n```" - } - ] - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3015, - "name": "getReturnDocuments", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3016, - "name": "getReturnDocuments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to retrieve any documents associated with a return. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async getReturnDocuments(\n data: Record\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getReturnDocuments()\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3017, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data attribute of the return that you're retrieving the documents for." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3018, - "name": "getShipmentDocuments", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3019, - "name": "getShipmentDocuments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to retrieve any documents associated with a shipment. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async getShipmentDocuments(\n data: Record\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getShipmentDocuments()\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3020, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " attribute of the shipment that you're retrieving the documents for." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3021, - "name": "retrieveDocuments", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3022, - "name": "retrieveDocuments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to retrieve any documents associated with an order and its fulfillments. This method isn't used by default in the backend, but you can use it for\ncustom use cases such as allowing admins to download these documents." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async retrieveDocuments(\n fulfillmentData: Record,\n documentType: \"invoice\" | \"label\"\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getDocuments()\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3023, - "name": "fulfillmentData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " attribute of the order's fulfillment." - } - ] - }, - "type": { - "type": "reference", - "target": 4875, - "name": "FulfillmentProviderData", - "package": "@medusajs/medusa" - } - }, - { - "id": 3024, - "name": "documentType", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of document to retrieve." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "label" - }, - { - "type": "literal", - "value": "invoice" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3035, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3036, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3037, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 3038, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3039, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3039 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - }, - { - "id": 2984, - "name": "validateFulfillmentData", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2985, - "name": "validateFulfillmentData", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is called when a shipping method is created. This typically happens when the customer chooses a shipping option during checkout, when a shipping method is created\nfor an order return, or in other similar cases. The shipping option and its data are validated before the shipping method is created.\n\nYou can use the provided parameters to validate the chosen shipping option. For example, you can check if the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object passed as a second parameter includes all data needed to\nfulfill the shipment later on.\n\nIf any of the data is invalid, you can throw an error. This error will stop Medusa from creating a shipping method and the error message will be returned as a result of the API Route." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The data that will be stored in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " property of the shipping method to be created.\nMake sure the value you return contains everything you need to fulfill the shipment later on. The returned value may also be used to calculate the price of the shipping method\nif it doesn't have a set price. It will be passed along to the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "calculatePrice", - "target": 2995, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " method." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async validateFulfillmentData(\n optionData: Record,\n data: Record,\n cart: Cart\n ): Promise> {\n if (data.id !== \"my-fulfillment\") {\n throw new Error(\"invalid data\")\n }\n\n return {\n ...data,\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 2986, - "name": "optionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data object of the shipping option selected when creating the shipping method." - } - ] - }, - "type": { - "type": "reference", - "target": 4874, - "name": "ShippingOptionData", - "package": "@medusajs/medusa" - } - }, - { - "id": 2987, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object passed in the body of the request." - } - ] - }, - "type": { - "type": "reference", - "target": 4875, - "name": "FulfillmentProviderData", - "package": "@medusajs/medusa" - } - }, - { - "id": 2988, - "name": "cart", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's cart details. It may be empty if the shipping method isn't associated with a cart, such as when it's associated with a claim." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2989, - "name": "validateOption", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2990, - "name": "validateOption", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Once the admin creates the shipping option, the data of the shipping option will be validated first using this method. This method is called when the [Create Shipping Option API Route](https://docs.medusajs.com/api/admin#shipping-options_postshippingoptions) is used." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Whether the fulfillment option is valid. If the returned value is false, an error is thrown and the shipping option will not be saved." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "text", - "text": "For example, you can use this method to ensure that the " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " object is correct:\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async validateOption(\n data: Record\n ): Promise {\n return data.id == \"my-fulfillment\"\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 2991, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the data object that is sent in the body of the request, basically, the data object of the shipping option. You can use this data to validate the shipping option before it is saved." - } - ] - }, - "type": { - "type": "reference", - "target": 4874, - "name": "ShippingOptionData", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "boolean" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3032, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3033, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3034, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3030, - 3029, - 3031, - 3025, - 3026 - ] - }, - { - "title": "Accessors", - "children": [ - 3027 - ] - }, - { - "title": "Methods", - "children": [ - 3040, - 2995, - 2992, - 3006, - 3000, - 3009, - 3012, - 2982, - 3015, - 3018, - 3021, - 3035, - 2984, - 2989, - 3032 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedBy": [ - { - "type": "reference", - "target": 3056, - "name": "AbstractFulfillmentService" - } - ] - }, - { - "id": 2704, - "name": "IBatchJobStrategy", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2722, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - } - }, - { - "id": 2721, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - } - }, - { - "id": 2723, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - } - }, - { - "id": 2717, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - } - }, - { - "id": 2718, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - } - }, - { - "id": 2719, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 2720, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - } - }, - { - "id": 2732, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2733, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 2734, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 2735, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 2736, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2737, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2738, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2739, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 2740, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 2741, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2742, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2743, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 2744, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2745, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2746, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2747, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - } - }, - { - "id": 2715, - "name": "buildTemplate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2716, - "name": "buildTemplate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Builds and returns a template file that can be downloaded and filled in" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2709, - "name": "preProcessBatchJob", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2710, - "name": "preProcessBatchJob", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Method for pre-processing a batch job" - } - ] - }, - "parameters": [ - { - "id": 2711, - "name": "batchJobId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2705, - "name": "prepareBatchJobForProcessing", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2706, - "name": "prepareBatchJobForProcessing", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Method for preparing a batch job for processing" - } - ] - }, - "parameters": [ - { - "id": 2707, - "name": "batchJobEntity", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3807, - "name": "CreateBatchJobInput", - "package": "@medusajs/medusa" - } - }, - { - "id": 2708, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", - "qualifiedName": "__global.Express.Request" - }, - "name": "Request", - "package": "@types/express-serve-static-core", - "qualifiedName": "__global.Express.Request" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3807, - "name": "CreateBatchJobInput", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2712, - "name": "processJob", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2713, - "name": "processJob", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Method does the actual processing of the job. Should report back on the progress of the operation." - } - ] - }, - "parameters": [ - { - "id": 2714, - "name": "batchJobId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2727, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2728, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2729, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 2730, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2731, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2731 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - }, - { - "id": 2724, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2725, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2726, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2722, - 2721, - 2723, - 2717, - 2718 - ] - }, - { - "title": "Accessors", - "children": [ - 2719 - ] - }, - { - "title": "Methods", - "children": [ - 2732, - 2715, - 2709, - 2705, - 2712, - 2727, - 2724 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedBy": [ - { - "type": "reference", - "target": 2748, - "name": "AbstractBatchJobStrategy" - } - ] - }, - { - "id": 2818, - "name": "ICartCompletionStrategy", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2819, - "name": "complete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2820, - "name": "complete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Takes a cart id and completes the cart. This for example takes place when\ncreating an order or confirming a swap." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the response for the completion request" - } - ] - } - ] - }, - "parameters": [ - { - "id": 2821, - "name": "cartId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the id of the Cart to complete." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2822, - "name": "idempotencyKey", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the idempotency key for the request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/idempotency-key.ts", - "qualifiedName": "IdempotencyKey" - }, - "name": "IdempotencyKey", - "package": "@medusajs/medusa" - } - }, - { - "id": 2823, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the request context for the completion request" - } - ] - }, - "type": { - "type": "reference", - "target": 4845, - "name": "RequestContext", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2814, - "name": "CartCompletionResponse", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [ - 2819 - ] - } - ], - "implementedBy": [ - { - "type": "reference", - "target": 2824, - "name": "AbstractCartCompletionStrategy" - } - ] - }, - { - "id": 2870, - "name": "IFileService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 2894, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - } - }, - { - "id": 2893, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - } - }, - { - "id": 2895, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - } - }, - { - "id": 2889, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - } - }, - { - "id": 2890, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - } - }, - { - "id": 2891, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 2892, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - } - }, - { - "id": 2904, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2905, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 2906, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 2907, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 2908, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2909, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2910, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2911, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 2912, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 2913, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2914, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2915, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 2916, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2917, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2918, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2919, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - } - }, - { - "id": 2877, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2878, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "remove file from fileservice" - } - ] - }, - "parameters": [ - { - "id": 2879, - "name": "fileData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Remove file described by record" - } - ] - }, - "type": { - "type": "reference", - "target": 4848, - "name": "DeleteFileType", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2883, - "name": "getDownloadStream", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2884, - "name": "getDownloadStream", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "download file from fileservice as stream" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "readable stream of the file to download" - } - ] - } - ] - }, - "parameters": [ - { - "id": 2885, - "name": "fileData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "file metadata relevant for fileservice to download the file" - } - ] - }, - "type": { - "type": "reference", - "target": 4868, - "name": "GetUploadedFileType", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/@types/node/globals.d.ts", - "qualifiedName": "NodeJS.ReadableStream" - }, - "name": "ReadableStream", - "package": "@types/node", - "qualifiedName": "NodeJS.ReadableStream" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2886, - "name": "getPresignedDownloadUrl", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2887, - "name": "getPresignedDownloadUrl", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate a presigned download url to obtain a file" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "presigned url to download the file" - } - ] - } - ] - }, - "parameters": [ - { - "id": 2888, - "name": "fileData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "file metadata relevant for fileservice to download the file" - } - ] - }, - "type": { - "type": "reference", - "target": 4868, - "name": "GetUploadedFileType", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2880, - "name": "getUploadStreamDescriptor", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2881, - "name": "getUploadStreamDescriptor", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "upload file to fileservice from stream" - } - ] - }, - "parameters": [ - { - "id": 2882, - "name": "fileData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "file metadata relevant for fileservice to create and upload the file" - } - ] - }, - "type": { - "type": "reference", - "target": 4853, - "name": "UploadStreamDescriptorType", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4860, - "name": "FileServiceGetUploadStreamResult", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2899, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 2900, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2901, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 2902, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2903, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2903 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - }, - { - "id": 2871, - "name": "upload", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2872, - "name": "upload", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "upload file to fileservice" - } - ] - }, - "parameters": [ - { - "id": 2873, - "name": "file", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Multer file from express multipart/form-data" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/multer/index.d.ts", - "qualifiedName": "__global.Express.Multer.File" - }, - "name": "File", - "package": "@types/multer", - "qualifiedName": "__global.Express.Multer.File" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4759, - "name": "FileServiceUploadResult", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2874, - "name": "uploadProtected", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2875, - "name": "uploadProtected", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "upload private file to fileservice" - } - ] - }, - "parameters": [ - { - "id": 2876, - "name": "file", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Multer file from express multipart/form-data" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/multer/index.d.ts", - "qualifiedName": "__global.Express.Multer.File" - }, - "name": "File", - "package": "@types/multer", - "qualifiedName": "__global.Express.Multer.File" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4759, - "name": "FileServiceUploadResult", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2896, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 2897, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2898, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2894, - 2893, - 2895, - 2889, - 2890 - ] - }, - { - "title": "Accessors", - "children": [ - 2891 - ] - }, - { - "title": "Methods", - "children": [ - 2904, - 2877, - 2883, - 2886, - 2880, - 2899, - 2871, - 2874, - 2896 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedBy": [ - { - "type": "reference", - "target": 2920, - "name": "AbstractFileService" - } - ] - }, - { - "id": 3144, - "name": "INotificationService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3160, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - } - }, - { - "id": 3159, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - } - }, - { - "id": 3161, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - } - }, - { - "id": 3155, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - } - }, - { - "id": 3156, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - } - }, - { - "id": 3157, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 3158, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - } - }, - { - "id": 3170, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3171, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 3172, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 3173, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 3174, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3175, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3176, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3177, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 3178, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 3179, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3180, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3181, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3182, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3183, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3184, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3185, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" - } - }, - { - "id": 3150, - "name": "resendNotification", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3151, - "name": "resendNotification", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3152, - "name": "notification", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 3153, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 3154, - "name": "attachmentGenerator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4889, - "name": "ReturnedData", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3145, - "name": "sendNotification", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3146, - "name": "sendNotification", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3147, - "name": "event", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3148, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 3149, - "name": "attachmentGenerator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4889, - "name": "ReturnedData", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3165, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3166, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3167, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 3168, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3169, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3169 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - }, - { - "id": 3162, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3163, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3164, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3160, - 3159, - 3161, - 3155, - 3156 - ] - }, - { - "title": "Accessors", - "children": [ - 3157 - ] - }, - { - "title": "Methods", - "children": [ - 3170, - 3150, - 3145, - 3165, - 3162 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ], - "implementedBy": [ - { - "type": "reference", - "target": 3186, - "name": "AbstractNotificationService" - } - ] - }, - { - "id": 3547, - "name": "IPriceSelectionStrategy", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3548, - "name": "calculateVariantPrice", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3549, - "name": "calculateVariantPrice", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Calculate the original and discount price for a given variant in a set of\ncircumstances described in the context." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "pricing details in an object containing the calculated lowest price,\nthe default price an all valid prices for the given variant" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3550, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 3551, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3553, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The variant's quantity." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3552, - "name": "variantId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The variant id of the variant for which to retrieve prices" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3553, - 3552 - ] - } - ] - } - } - } - }, - { - "id": 3554, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Details relevant to determine the correct pricing of the variant" - } - ] - }, - "type": { - "type": "reference", - "target": 3613, - "name": "PriceSelectionContext", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es2015.collection.d.ts", - "qualifiedName": "Map" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 3629, - "name": "PriceSelectionResult", - "package": "@medusajs/medusa" - } - ], - "name": "Map", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3555, - "name": "onVariantsPricesUpdate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3556, - "name": "onVariantsPricesUpdate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Notify price selection strategy that variants prices have been updated." - } - ] - }, - "parameters": [ - { - "id": 3557, - "name": "variantIds", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ids of the updated variants" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3558, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3559, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3560, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 4908, - "name": "ITransactionBaseService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 4907, - "name": "ITransactionBaseService.withTransaction" - } - } - ], - "groups": [ - { - "title": "Methods", - "children": [ - 3548, - 3555, - 3558 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 4906, - "name": "ITransactionBaseService", - "package": "@medusajs/types" - } - ], - "implementedBy": [ - { - "type": "reference", - "target": 3561, - "name": "AbstractPriceSelectionStrategy" - } - ] - }, - { - "id": 3637, - "name": "ITaxCalculationStrategy", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 3638, - "name": "calculate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3639, - "name": "calculate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Calculates the tax amount for a given set of line items under applicable\ntax conditions and calculation contexts." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the tax total" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3640, - "name": "items", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the line items to calculate the tax total for" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", - "qualifiedName": "LineItem" - }, - "name": "LineItem", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 3641, - "name": "taxLines", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the tax lines that applies to the calculation" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/line-item-tax-line.ts", - "qualifiedName": "LineItemTaxLine" - }, - "name": "LineItemTaxLine", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-method-tax-line.ts", - "qualifiedName": "ShippingMethodTaxLine" - }, - "name": "ShippingMethodTaxLine", - "package": "@medusajs/medusa" - } - ] - } - } - }, - { - "id": 3642, - "name": "calculationContext", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "other details relevant for the calculation" - } - ] - }, - "type": { - "type": "reference", - "target": 3697, - "name": "TaxCalculationContext", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "number" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [ - 3638 - ] - } - ], - "implementedBy": [ - { - "type": "reference", - "target": 3643, - "name": "AbstractTaxCalculationStrategy" - } - ] - }, - { - "id": 3705, - "name": "ITaxService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Interface to be implemented by tax provider plugins. The interface defines a\nsingle method " - }, - { - "kind": "code", - "text": "`getTaxLines`" - }, - { - "kind": "text", - "text": " that returns numerical rates to apply to line\nitems and shipping methods." - } - ] - }, - "children": [ - { - "id": 3706, - "name": "getTaxLines", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3707, - "name": "getTaxLines", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieves the numerical tax lines for a calculation context." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "numerical tax rates that should apply to the provided calculation\n lines" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3708, - "name": "itemLines", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the line item calculation lines" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 3693, - "name": "ItemTaxCalculationLine", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 3709, - "name": "shippingLines", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 3689, - "name": "ShippingTaxCalculationLine", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 3710, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "other details relevant to the tax determination" - } - ] - }, - "type": { - "type": "reference", - "target": 3697, - "name": "TaxCalculationContext", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 4924, - "name": "ProviderTaxLine", - "package": "@medusajs/medusa" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [ - 3706 - ] - } - ], - "implementedBy": [ - { - "type": "reference", - "target": 3711, - "name": "AbstractTaxService" - } - ] - }, - { - "id": 4906, - "name": "ITransactionBaseService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 4907, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 4908, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4909, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [ - 4907 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 3547, - "name": "IPriceSelectionStrategy" - } - ] - }, - { - "id": 5081, - "name": "JoinerServiceConfig", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 5083, - "name": "alias", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Property name to use as entrypoint to the service" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 5191, - "name": "JoinerServiceConfigAlias", - "package": "@medusajs/types" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 5191, - "name": "JoinerServiceConfigAlias", - "package": "@medusajs/types" - } - } - ] - } - }, - { - "id": 5094, - "name": "args", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extra arguments to pass to the remoteFetchData callback" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 5090, - "name": "extends", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, "type": { "type": "array", "elementType": { "type": "reflection", "declaration": { - "id": 5091, + "id": 384, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 5093, - "name": "relationship", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 5194, - "name": "JoinerRelationship", - "package": "@medusajs/types" - } - }, - { - "id": 5092, - "name": "serviceName", + "id": 385, + "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the item" + } + ] + }, "type": { "type": "intrinsic", "name": "string" @@ -81453,7573 +9388,79 @@ { "title": "Properties", "children": [ - 5093, - 5092 + 385 ] } ] } } } - }, - { - "id": 5084, - "name": "fieldAlias", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 5085, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5087, - "name": "forwardArgumentsOnPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 5086, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5087, - 5086 - ] - } - ] - } - } - ] - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 5088, - "name": "primaryKeys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 5089, - "name": "relationships", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5194, - "name": "JoinerRelationship", - "package": "@medusajs/types" - } - } - }, - { - "id": 5082, - "name": "serviceName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ + { + "title": "Constructors", + "children": [ + 381 + ] + }, { "title": "Properties", "children": [ - 5083, - 5094, - 5090, - 5084, - 5088, - 5089, - 5082 + 383 ] } ] }, { - "id": 5191, - "name": "JoinerServiceConfigAlias", + "id": 289, + "name": "AdminGetDiscountsDiscountConditionsConditionParams", "variant": "declaration", - "kind": 256, + "kind": 128, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, "children": [ { - "id": 5193, - "name": "args", + "id": 290, + "name": "constructor", "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extra arguments to pass to the remoteFetchData callback" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 5192, - "name": "name", - "variant": "declaration", - "kind": 1024, + "kind": 512, "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5193, - 5192 - ] - } - ] - }, - { - "id": 4142, - "name": "MedusaRequest", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 4150, - "name": "allowedProperties", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Request.allowedProperties" - } - }, - { - "id": 4152, - "name": "errors", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Request.errors" - } - }, - { - "id": 4149, - "name": "filterableFields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Request.filterableFields" - } - }, - { - "id": 4151, - "name": "includes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Request.includes" - } - }, - { - "id": 4147, - "name": "listConfig", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 3847, - "typeArguments": [ - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "FindConfig", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Request.listConfig" - } - }, - { - "id": 4148, - "name": "retrieveConfig", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 3847, - "typeArguments": [ - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "FindConfig", - "package": "@medusajs/medusa" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Request.retrieveConfig" - } - }, - { - "id": 4144, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 4894, - "name": "MedusaContainer", - "package": "medusa-core-utils" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Request.scope" - } - }, - { - "id": 4143, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "unknown", - "name": "(User | Customer) & { customer_id?: string | undefined; userId?: string | undefined; }" - }, - "overwrites": { - "type": "reference", - "target": -1, - "name": "Request.user" - } - }, - { - "id": 4146, - "name": "validatedBody", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Request.validatedBody" - } - }, - { - "id": 4145, - "name": "validatedQuery", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { + "signatures": [ + { + "id": 291, + "name": "new AdminGetDiscountsDiscountConditionsConditionParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { "type": "reference", - "target": 3894, - "name": "RequestQueryFields", + "target": 289, + "name": "AdminGetDiscountsDiscountConditionsConditionParams", "package": "@medusajs/medusa" }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "Request.validatedQuery" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4150, - 4152, - 4149, - 4151, - 4147, - 4148, - 4144, - 4143, - 4146, - 4145 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Request" - }, - "name": "Request", - "package": "@types/express", - "qualifiedName": "e.Request" - } - ] - }, - { - "id": 3900, - "name": "PaginatedResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pagination fields returned in the response of an API route." - } - ] - }, - "children": [ - { - "id": 3903, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of items available." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3901, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum number of items that can be returned in the list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3902, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items skipped before the returned items in the list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3903, - 3901, - 3902 - ] - } - ] - }, - { - "id": 3261, - "name": "PaymentProcessor", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "## Overview\n\nA Payment Processor is the payment method used to authorize, capture, and refund payment, among other actions. An example of a Payment Processor is Stripe.\n\nBy default, Medusa has a " - }, - { - "kind": "code", - "text": "`manual`" - }, - { - "kind": "text", - "text": " payment provider that has minimal implementation. It can be synonymous with a Cash on Delivery payment method. It allows\nstore operators to manage the payment themselves but still keep track of its different stages on Medusa.\n\nA payment processor is a service that extends the " - }, - { - "kind": "code", - "text": "`AbstractPaymentProcessor`" - }, - { - "kind": "text", - "text": " and implements its methods. So, adding a Payment Processor is as simple as\ncreating a service file in " - }, - { - "kind": "code", - "text": "`src/services`" - }, - { - "kind": "text", - "text": ". The file's name is the payment processor's class name as a slug and without the word " - }, - { - "kind": "code", - "text": "`Service`" - }, - { - "kind": "text", - "text": ".\nFor example, if you're creating a " - }, - { - "kind": "code", - "text": "`MyPaymentService`" - }, - { - "kind": "text", - "text": " class, the file name is " - }, - { - "kind": "code", - "text": "`src/services/my-payment.ts`" - }, - { - "kind": "text", - "text": ".\n\n" - }, - { - "kind": "code", - "text": "```ts\nimport { AbstractPaymentProcessor } from \"@medusajs/medusa\";\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // methods here...\n}\n\nexport default MyPaymentService\n```" - }, - { - "kind": "text", - "text": "\n\nThe methods of the payment processor are used at different points in the Checkout flow as well as when processing an order after it’s placed.\n\n![Checkout Flow - Payment](https://res.cloudinary.com/dza7lstvk/image/upload/v1680177820/Medusa%20Docs/Diagrams/checkout-payment_cy9efp.jpg)\n\n---\n\n## Identifier Property\n\nThe " - }, - { - "kind": "code", - "text": "`PaymentProvider`" - }, - { - "kind": "text", - "text": " entity has 2 properties: " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " and " - }, - { - "kind": "code", - "text": "`is_installed`" - }, - { - "kind": "text", - "text": ". The " - }, - { - "kind": "code", - "text": "`identifier`" - }, - { - "kind": "text", - "text": " property in the payment processor service is used when the payment processor is added to the database.\n\nThe value of this property is also used to reference the payment processor throughout Medusa.\nFor example, it is used to [add a payment processor](https://docs.medusajs.com/api/admin#regions_postregionsregionpaymentproviders) to a region.\n\n" - }, - { - "kind": "code", - "text": "```ts\nclass MyPaymentService extends AbstractPaymentProcessor {\n static identifier = \"my-payment\"\n // ...\n}\n```" - }, - { - "kind": "text", - "text": "\n\n---\n\n## PaymentProcessorError\n\nBefore diving into the methods of the Payment Processor, you'll notice that part of the expected return signature of these method includes " - }, - { - "kind": "code", - "text": "`PaymentProcessorError`" - }, - { - "kind": "text", - "text": ".\n\n" - }, - { - "kind": "code", - "text": "```ts\ninterface PaymentProcessorError {\n error: string\n code?: string\n detail?: any\n}\n```" - }, - { - "kind": "text", - "text": "\n\nWhile implementing the Payment Processor's methods, if you need to inform the Medusa core that an error occurred at a certain stage,\nreturn an object having the attributes defined in the " - }, - { - "kind": "code", - "text": "`PaymentProcessorError`" - }, - { - "kind": "text", - "text": " interface.\n\nFor example, the Stripe payment processor has the following method to create the error object, which is used within other methods:\n\n" - }, - { - "kind": "code", - "text": "```ts\nabstract class StripeBase extends AbstractPaymentProcessor {\n // ...\n protected buildError(\n message: string,\n e: Stripe.StripeRawError | PaymentProcessorError | Error\n ): PaymentProcessorError {\n return {\n error: message,\n code: \"code\" in e ? e.code : \"\",\n detail: isPaymentProcessorError(e)\n ? `${e.error}${EOL}${e.detail ?? \"\"}`\n : \"detail\" in e\n ? e.detail\n : e.message ?? \"\",\n }\n }\n\n // used in other methods\n async retrievePayment(\n paymentSessionData: Record\n ): Promise<\n PaymentProcessorError |\n PaymentProcessorSessionResponse[\"session_data\"]\n > {\n try {\n // ...\n } catch (e) {\n return this.buildError(\n \"An error occurred in retrievePayment\",\n e\n )\n }\n }\n}\n```" - }, - { - "kind": "text", - "text": "\n\n---" - } - ] - }, - "children": [ - { - "id": 3274, - "name": "authorizePayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3275, - "name": "authorizePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to authorize payment using the Payment Session of an order. This is called when the\n[cart is completed](https://docs.medusajs.com/api/store#carts_postcartscartcomplete) and before the order is created.\n\nThis method is also used for authorizing payments of a swap of an order and when authorizing sessions in a payment collection.\nYou can interact with a third-party provider and perform any actions necessary to authorize the payment.\n\nThe payment authorization might require additional action from the customer before it is declared authorized. Once that additional action is performed,\nthe " - }, - { - "kind": "code", - "text": "`authorizePayment`" - }, - { - "kind": "text", - "text": " method will be called again to validate that the payment is now fully authorized. So, make sure to implement it for this case as well, if necessary.\n\nOnce the payment is authorized successfully and the Payment Session status is set to " - }, - { - "kind": "code", - "text": "`authorized`" - }, - { - "kind": "text", - "text": ", the associated order or swap can then be placed or created.\nIf the payment authorization fails, then an error will be thrown and the order will not be created.\n\n:::note\n\nThe payment authorization status is determined using the " - }, - { - "kind": "inline-tag", - "tag": "@link", - "text": "getPaymentStatus", - "target": 3293, - "tsLinkText": "" - }, - { - "kind": "text", - "text": " method. If the status is " - }, - { - "kind": "code", - "text": "`requires_more`" - }, - { - "kind": "text", - "text": ", then it means additional actions are required\nfrom the customer. If you try to create the order with a status that isn't " - }, - { - "kind": "code", - "text": "`authorized`" - }, - { - "kind": "text", - "text": ", the process will fail.\n\n:::" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The authorization details or an error object." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError,\n PaymentSessionStatus,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async authorizePayment(\n paymentSessionData: Record,\n context: Record\n ): Promise<\n PaymentProcessorError |\n {\n status: PaymentSessionStatus;\n data: Record;\n }\n > {\n try {\n await this.client.authorize(paymentSessionData.id)\n\n return {\n status: PaymentSessionStatus.AUTHORIZED,\n data: {\n id: paymentSessionData.id\n }\n }\n } catch (e) {\n return {\n error: e.message\n }\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3276, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the payment session." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3277, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The context of the authorization. It may include some of the following fields:\n\n- " - }, - { - "kind": "code", - "text": "`ip`" - }, - { - "kind": "text", - "text": ": The customer’s IP.\n- " - }, - { - "kind": "code", - "text": "`idempotency_key`" - }, - { - "kind": "text", - "text": ": The [Idempotency Key](https://docs.medusajs.com/modules/carts-and-checkout/payment#idempotency-key) that is associated with the current cart. It is useful when retrying payments, retrying checkout at a failed point, or for payments that require additional actions from the customer.\n- " - }, - { - "kind": "code", - "text": "`cart_id`" - }, - { - "kind": "text", - "text": ": The ID of a cart. This is only during operations like placing an order or creating a swap." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 3278, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3280, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " to be stored in the payment session's " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3279, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The status of the payment, which will be stored in the payment session's " - }, - { - "kind": "code", - "text": "`status`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSessionStatus" - }, - "name": "PaymentSessionStatus", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3280, - 3279 - ] - } - ] - } - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3290, - "name": "cancelPayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3291, - "name": "cancelPayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to cancel an order’s payment. This method is typically triggered by one of the following situations:\n\n1. Before an order is placed and after the payment is authorized, an inventory check is done on products to ensure that products are still available for purchase. If the inventory check fails for any of the products, the payment is canceled.\n2. If the store operator cancels the order from the admin.\n3. When the payment of an order's swap is canceled.\n\nYou can utilize this method to interact with the third-party provider and perform any actions necessary to cancel the payment." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Either an error object or a value that's stored in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async cancelPayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n const cancelData = this.client.cancel(paymentId)\n\n return {\n id: paymentId,\n ...cancelData\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3292, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3281, - "name": "capturePayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3282, - "name": "capturePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to capture the payment amount of an order. This is typically triggered manually by the store operator from the admin.\n\nThis method is also used for capturing payments of a swap of an order, or when a request is sent to the [Capture Payment API Route](https://docs.medusajs.com/api/admin#payments_postpaymentspaymentcapture).\n\nYou can utilize this method to interact with the third-party provider and perform any actions necessary to capture the payment." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Either an error object or a value that's stored in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async capturePayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n const captureData = this.client.catch(paymentId)\n\n return {\n id: paymentId,\n ...captureData\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3283, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment for its first parameter." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3284, - "name": "deletePayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3285, - "name": "deletePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to perform any actions necessary before a Payment Session is deleted. The Payment Session is deleted in one of the following cases:\n\n1. When a request is sent to [delete the Payment Session](https://docs.medusajs.com/api/store#carts_deletecartscartpaymentsessionssession).\n2. When the [Payment Session is refreshed](https://docs.medusajs.com/api/store#carts_postcartscartpaymentsessionssession). The Payment Session is deleted so that a newer one is initialized instead.\n3. When the Payment Processor is no longer available. This generally happens when the store operator removes it from the available Payment Processor in the admin.\n4. When the region of the store is changed based on the cart information and the Payment Processor is not available in the new region." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Either an error object or an empty object." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async deletePayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n // assuming client is an initialized client\n // communicating with a third-party service.\n this.client.delete(paymentId)\n\n return {}\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3286, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment Session." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3293, - "name": "getPaymentStatus", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3294, - "name": "getPaymentStatus", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to get the status of a Payment or a Payment Session. Its main usage is within the place order and create swap flows.\nIf the status returned is not " - }, - { - "kind": "code", - "text": "`authorized`" - }, - { - "kind": "text", - "text": " within these flows, then the payment is considered failed and an error will be thrown, stopping the flow from completion." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The status of the Payment or Payment Session." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentSessionStatus\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async getPaymentStatus(\n paymentSessionData: Record\n ): Promise {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n return await this.client.getStatus(paymentId) as PaymentSessionStatus\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3295, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of a Payment as a parameter. You can use this data to interact with the third-party provider to check the status of the payment if necessary." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSessionStatus" - }, - "name": "PaymentSessionStatus", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3264, - "name": "initiatePayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3265, - "name": "initiatePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is called either if a region has only one payment provider enabled or when [a Payment Session is selected](https://docs.medusajs.com/api/store#carts_postcartscartpaymentsession),\nwhich occurs when the customer selects their preferred payment method during checkout.\n\nIt is used to allow you to make any necessary calls to the third-party provider to initialize the payment. For example, in Stripe this method is used to create a Payment Intent for the customer." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Either the payment's data or an error object." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentContext,\n PaymentSessionResponse,\n // ...\n} from \"@medusajs/medusa\"\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async initiatePayment(\n context: PaymentProcessorContext\n ): Promise<\n PaymentProcessorError | PaymentProcessorSessionResponse\n > {\n // assuming client is an initialized client\n // communicating with a third-party service.\n const clientPayment = await this.client.initiate(context)\n\n return {\n session_data: {\n id: clientPayment.id\n },\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3266, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The context of the payment." - } - ] - }, - "type": { - "type": "reference", - "target": 3243, - "name": "PaymentProcessorContext", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3252, - "name": "PaymentProcessorSessionResponse", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3270, - "name": "refundPayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3271, - "name": "refundPayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to refund an order’s payment. This is typically triggered manually by the store operator from the admin. The refund amount might be the total order amount or part of it.\n\nThis method is also used for refunding payments of a swap or a claim of an order, or when a request is sent to the [Refund Payment API Route](https://docs.medusajs.com/api/admin#payments_postpaymentspaymentrefunds).\n\nYou can utilize this method to interact with the third-party provider and perform any actions necessary to refund the payment." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Either an error object or a value that's stored in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async refundPayment(\n paymentSessionData: Record,\n refundAmount: number\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n const refundData = this.client.refund(paymentId, refundAmount)\n\n return {\n id: paymentId,\n ...refundData\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3272, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of a Payment." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3273, - "name": "refundAmount", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the amount to refund." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3287, - "name": "retrievePayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3288, - "name": "retrievePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to provide a uniform way of retrieving the payment information from the third-party provider.\nFor example, in Stripe’s Payment Processor this method is used to retrieve the payment intent details from Stripe." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The payment's data, typically retrieved from a third-party provider." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async retrievePayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n return await this.client.retrieve(paymentId)\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3289, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of a Payment Session. Make sure to store in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field any necessary data that would allow you to retrieve the payment data from the third-party provider." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3267, - "name": "updatePayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3268, - "name": "updatePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to update the payment session when the payment amount changes. It's called whenever the cart or any of its related data is updated.\nFor example, when a [line item is added to the cart](https://docs.medusajs.com/api/store#carts_postcartscartlineitems) or when a\n[shipping method is selected](https://docs.medusajs.com/api/store#carts_postcartscartshippingmethod)." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "Either the payment's data or an error object." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorContext,\n PaymentProcessorError,\n PaymentProcessorSessionResponse,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async updatePayment(\n context: PaymentProcessorContext\n ): Promise<\n void |\n PaymentProcessorError |\n PaymentProcessorSessionResponse\n > {\n // assuming client is an initialized client\n // communicating with a third-party service.\n const paymentId = context.paymentSessionData.id\n\n await this.client.update(paymentId, context)\n\n return {\n session_data: context.paymentSessionData\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3269, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The context of the payment." - } - ] - }, - "type": { - "type": "reference", - "target": 3243, - "name": "PaymentProcessorContext", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3252, - "name": "PaymentProcessorSessionResponse", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3296, - "name": "updatePaymentData", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3297, - "name": "updatePaymentData", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This method is used to update the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of a payment session. It's called when a request is sent to the\n[Update Payment Session API Route](https://docs.medusajs.com/api/store#carts_postcartscartpaymentsessionupdate), or when the " - }, - { - "kind": "code", - "text": "`CartService`" - }, - { - "kind": "text", - "text": "'s " - }, - { - "kind": "code", - "text": "`updatePaymentSession`" - }, - { - "kind": "text", - "text": " is used.\n\nThis method can also be used to update the data in the third-party payment provider, if necessary." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the data to store in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the payment session.\nYou can keep the data as-is, or make changes to it by communicating with the third-party provider." - } - ] - }, - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\nimport {\n PaymentProcessorError,\n PaymentProviderService,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n protected paymentProviderService: PaymentProviderService\n // ...\n constructor(container, options) {\n super(container)\n this.paymentProviderService = container.paymentProviderService\n // ...\n }\n // ...\n async updatePaymentData(\n sessionId: string,\n data: Record\n ): Promise<\n Record |\n PaymentProcessorError\n > {\n const paymentSession = await this.paymentProviderService.retrieveSession(sessionId)\n // assuming client is an initialized client\n // communicating with a third-party service.\n const clientPayment = await this.client.update(paymentSession.data.id, data)\n\n return {\n id: clientPayment.id\n }\n }\n}\n```" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3298, - "name": "sessionId", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the payment session." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3299, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data to be updated in the payment session." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [ - 3274, - 3290, - 3281, - 3284, - 3293, - 3264, - 3270, - 3287, - 3267, - 3296 - ] - } - ], - "implementedBy": [ - { - "type": "reference", - "target": 3300, - "name": "AbstractPaymentProcessor" - } - ] - }, - { - "id": 3243, - "name": "PaymentProcessorContext", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A payment's context." - } - ] - }, - "children": [ - { - "id": 3247, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The payment's amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3244, - "name": "billing_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The payment's billing address." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/address.ts", - "qualifiedName": "Address" - }, - "name": "Address", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 3250, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The cart's context." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3246, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The selected currency code, typically associated with the customer's cart." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3249, - "name": "customer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer associated with this payment." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer.ts", - "qualifiedName": "Customer" - }, - "name": "Customer", - "package": "@medusajs/medusa" - } - }, - { - "id": 3245, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's email." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3251, - "name": "paymentSessionData", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the payment session hasn't been created or initiated yet, it'll be an empty object.\nIf the payment session exists, it'll be the value of the payment session's " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3248, - "name": "resource_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the resource the payment is associated with. For example, the cart's ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3247, - 3244, - 3250, - 3246, - 3249, - 3245, - 3251, - 3248 - ] - } - ] - }, - { - "id": 3257, - "name": "PaymentProcessorError", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object that is returned in case of an error." - } - ] - }, - "children": [ - { - "id": 3259, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The error code." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3260, - "name": "detail", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Any additional helpful details." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 3258, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The error message" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3259, - 3260, - 3258 - ] - } - ] - }, - { - "id": 3252, - "name": "PaymentProcessorSessionResponse", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The response of operations on a payment." - } - ] - }, - "children": [ - { - "id": 3256, - "name": "session_data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data to be stored in the " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field of the Payment Session to be created.\nThe " - }, - { - "kind": "code", - "text": "`data`" - }, - { - "kind": "text", - "text": " field is useful to hold any data required by the third-party provider to process the payment or retrieve its details at a later point." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3253, - "name": "update_requests", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to specify data that should be updated in the Medusa backend." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3254, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3255, - "name": "customer_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Specifies a new value of the " - }, - { - "kind": "code", - "text": "`metadata`" - }, - { - "kind": "text", - "text": " field of the customer associated with the payment." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3255 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3256, - 3253 - ] - } - ] - }, - { - "id": 3374, - "name": "PaymentService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use the new PaymentProcessor interface instead" - } - ] - } - ] - }, - "children": [ - { - "id": 3430, - "name": "__configModule__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3771, - "name": "TransactionBaseService.__configModule__" - } - }, - { - "id": 3429, - "name": "__container__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isReadonly": true - }, - "type": { - "type": "intrinsic", - "name": "any" - }, - "inheritedFrom": { - "type": "reference", - "target": 3770, - "name": "TransactionBaseService.__container__" - } - }, - { - "id": 3431, - "name": "__moduleDeclaration__", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true, - "isOptional": true, - "isReadonly": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 3772, - "name": "TransactionBaseService.__moduleDeclaration__" - } - }, - { - "id": 3425, - "name": "manager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": 3766, - "name": "TransactionBaseService.manager_" - } - }, - { - "id": 3426, - "name": "transactionManager_", - "variant": "declaration", - "kind": 1024, - "flags": { - "isProtected": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "undefined" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 3767, - "name": "TransactionBaseService.transactionManager_" - } - }, - { - "id": 3427, - "name": "activeManager_", - "variant": "declaration", - "kind": 262144, - "flags": { - "isProtected": true - }, - "getSignature": { - "id": 3428, - "name": "activeManager_", - "variant": "signature", - "kind": 524288, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - }, - "inheritedFrom": { - "type": "reference", - "target": -1, - "name": "TransactionBaseService.activeManager_" - } - }, - "inheritedFrom": { - "type": "reference", - "target": 3768, - "name": "TransactionBaseService.activeManager_" - } - }, - { - "id": 3440, - "name": "atomicPhase_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3441, - "name": "atomicPhase_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "the result of the transactional work" - } - ] - } - ] - }, - "typeParameter": [ - { - "id": 3442, - "name": "TResult", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 3443, - "name": "TError", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 3444, - "name": "work", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the transactional work to be done" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3445, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3446, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3447, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 3448, - "name": "isolationOrErrorHandler", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the isolation level to be used for the work." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", - "qualifiedName": "IsolationLevel" - }, - "name": "IsolationLevel", - "package": "typeorm" - }, - { - "type": "reflection", - "declaration": { - "id": 3449, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3450, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3451, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 3452, - "name": "maybeErrorHandlerOrDontFail", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Potential error handler" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3453, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3454, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3455, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 2735, - "name": "TError", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 2734, - "name": "TResult", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - }, "inheritedFrom": { "type": "reference", - "target": 3782, - "name": "TransactionBaseService.atomicPhase_" + "target": 3972, + "name": "FindParams.constructor" } } ], "inheritedFrom": { "type": "reference", - "target": 3781, - "name": "TransactionBaseService.atomicPhase_" + "target": 3971, + "name": "FindParams.constructor" } }, { - "id": 3399, - "name": "authorizePayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3400, - "name": "authorizePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use PaymentProcessor.authorizePayment instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3401, - "name": "paymentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSession" - }, - "name": "PaymentSession", - "package": "@medusajs/medusa" - } - }, - { - "id": 3402, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reflection", - "declaration": { - "id": 3403, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3404, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - }, - { - "id": 3405, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSessionStatus" - }, - "name": "PaymentSessionStatus", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3404, - 3405 - ] - } - ] - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3413, - "name": "cancelPayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3414, - "name": "cancelPayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use PaymentProcessor.cancelPayment instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3415, - "name": "payment", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment.ts", - "qualifiedName": "Payment" - }, - "name": "Payment", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3406, - "name": "capturePayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3407, - "name": "capturePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use PaymentProcessor.capturePayment instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3408, - "name": "payment", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment.ts", - "qualifiedName": "Payment" - }, - "name": "Payment", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3384, - "name": "createPayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3385, - "name": "createPayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use PaymentProcessor.initiatePayment instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3386, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of this argument is meant to be temporary and once the previous method signature\nwill be removed, the type will only be PaymentContext instead of Cart & PaymentContext" - } - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3353, - "name": "PaymentContext", - "package": "@medusajs/medusa" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3368, - "name": "PaymentSessionResponse", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 3387, - "name": "createPayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use createPayment(context: " - }, - { - "kind": "code", - "text": "`Cart & PaymentContext): Promise`" - }, - { - "kind": "text", - "text": " instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3388, - "name": "cart", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3416, - "name": "deletePayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3417, - "name": "deletePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use PaymentProcessor.cancelPayment instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3418, - "name": "paymentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSession" - }, - "name": "PaymentSession", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3375, - "name": "getIdentifier", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3376, - "name": "getIdentifier", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 3377, - "name": "getPaymentData", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3378, - "name": "getPaymentData", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use PaymentProcessor.retrievePayment instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3379, - "name": "paymentSession", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSession" - }, - "name": "PaymentSession", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3422, - "name": "getStatus", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3423, - "name": "getStatus", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use PaymentProcessor.getPaymentStatus instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3424, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSessionStatus" - }, - "name": "PaymentSessionStatus", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3409, - "name": "refundPayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3410, - "name": "refundPayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use PaymentProcessor.refundPayment instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3411, - "name": "payment", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment.ts", - "qualifiedName": "Payment" - }, - "name": "Payment", - "package": "@medusajs/medusa" - } - }, - { - "id": 3412, - "name": "refundAmount", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3389, - "name": "retrievePayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3390, - "name": "retrievePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use PaymentProcessor.retrievePayment instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3391, - "name": "paymentData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3419, - "name": "retrieveSavedMethods", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3420, - "name": "retrieveSavedMethods", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use PaymentProcessor.getSavedMethods instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3421, - "name": "customer", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer.ts", - "qualifiedName": "Customer" - }, - "name": "Customer", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3435, - "name": "shouldRetryTransaction_", - "variant": "declaration", - "kind": 2048, - "flags": { - "isProtected": true - }, - "signatures": [ - { - "id": 3436, - "name": "shouldRetryTransaction_", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3437, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 3438, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3439, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3439 - ] - } - ] - } - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "inheritedFrom": { - "type": "reference", - "target": 3777, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3776, - "name": "TransactionBaseService.shouldRetryTransaction_" - } - }, - { - "id": 3392, - "name": "updatePayment", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3393, - "name": "updatePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3394, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - }, - { - "id": 3395, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3353, - "name": "PaymentContext", - "package": "@medusajs/medusa" - } - ] - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 3368, - "name": "PaymentSessionResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 3396, - "name": "updatePayment", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use PaymentProcessor.updatePayment instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3397, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - }, - { - "id": 3398, - "name": "cart", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3380, - "name": "updatePaymentData", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3381, - "name": "updatePaymentData", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "This will be" - } - ], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "in the near future use PaymentProcessor.updatePayment instead" - } - ] - } - ] - }, - "parameters": [ - { - "id": 3382, - "name": "paymentSessionData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - }, - { - "id": 3383, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 3432, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 3433, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3434, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - }, - "inheritedFrom": { - "type": "reference", - "target": 3774, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 3773, - "name": "TransactionBaseService.withTransaction" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3430, - 3429, - 3431, - 3425, - 3426 - ] - }, - { - "title": "Accessors", - "children": [ - 3427 - ] - }, - { - "title": "Methods", - "children": [ - 3440, - 3399, - 3413, - 3406, - 3384, - 3416, - 3375, - 3377, - 3422, - 3409, - 3389, - 3419, - 3435, - 3392, - 3380, - 3432 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 3760, - "name": "TransactionBaseService", - "package": "@medusajs/medusa" - } - ] - }, - { - "id": 5255, - "name": "ProductCategoryDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A product category's data." - } - ] - }, - "children": [ - { - "id": 5264, - "name": "category_children", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated child categories." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5255, - "name": "ProductCategoryDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 5265, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product category was created." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 5258, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the product category." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5259, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The handle of the product category. The handle can be used to create slug URL paths." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5256, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product category." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5260, - "name": "is_active", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the product category is active." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5261, - "name": "is_internal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5257, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the product category." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5263, - "name": "parent_category", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated parent category." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "reference", - "target": 5255, - "name": "ProductCategoryDTO", - "package": "@medusajs/types" - } - }, - { - "id": 5262, - "name": "rank", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ranking of the product category among sibling categories." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 5266, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product category was updated." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5264, - 5265, - 5258, - 5259, - 5256, - 5260, - 5261, - 5257, - 5263, - 5262, - 5266 - ] - } - ] - }, - { - "id": 5248, - "name": "ProductCollectionDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A product collection's data." - } - ] - }, - "children": [ - { - "id": 5253, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product collection was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 5251, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The handle of the product collection. The handle can be used to create slug URL paths." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5249, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product collection." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5252, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Holds custom data in key-value pairs." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - }, - { - "id": 5254, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated products." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5150, - "name": "ProductDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 5250, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the product collection." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5253, - 5251, - 5249, - 5252, - 5254, - 5250 - ] - } - ] - }, - { - "id": 5150, - "name": "ProductDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A product's data." - } - ] - }, - "children": [ - { - "id": 5168, - "name": "categories", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product categories." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 5255, - "name": "ProductCategoryDTO", - "package": "@medusajs/types" - } - } - ] - } - }, - { - "id": 5167, - "name": "collection", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product collection." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "reference", - "target": 5248, - "name": "ProductCollectionDTO", - "package": "@medusajs/types" - } - }, - { - "id": 5176, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product was created." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 5178, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 5155, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The description of the product." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5174, - "name": "discountable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the product can be discounted." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5175, - "name": "external_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5153, - "name": "handle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The handle of the product. The handle can be used to create slug URL paths." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5162, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the product." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 5164, - "name": "hs_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HS Code of the product." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5151, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5173, - "name": "images", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product images." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5277, - "name": "ProductImageDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 5156, - "name": "is_giftcard", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the product is a gift card." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5161, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The length of the product." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 5166, - "name": "material", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The material of the product." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5179, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Holds custom data in key-value pairs." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 5165, - "name": "mid_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The MID Code of the product." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5172, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product options." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5236, - "name": "ProductOptionDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 5163, - "name": "origin_country", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The origin country of the product." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5157, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The status of the product." - } - ] - }, - "type": { - "type": "reference", - "target": 5243, - "name": "ProductStatus", - "package": "@medusajs/types" - } - }, - { - "id": 5154, - "name": "subtitle", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The subttle of the product." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5170, - "name": "tags", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product tags." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5272, - "name": "ProductTagDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 5158, - "name": "thumbnail", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the product's thumbnail." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5152, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5169, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product type." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5267, - "name": "ProductTypeDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 5177, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product was updated." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 5171, - "name": "variants", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product variants." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4981, - "name": "ProductVariantDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 5160, - "name": "weight", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The weight of the product." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 5159, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the product." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5168, - 5167, - 5176, - 5178, - 5155, - 5174, - 5175, - 5153, - 5162, - 5164, - 5151, - 5173, - 5156, - 5161, - 5166, - 5179, - 5165, - 5172, - 5163, - 5157, - 5154, - 5170, - 5158, - 5152, - 5169, - 5177, - 5171, - 5160, - 5159 - ] - } - ] - }, - { - "id": 5277, - "name": "ProductImageDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product image's data." - } - ] - }, - "children": [ - { - "id": 5281, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product image was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 5278, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product image." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5280, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Holds custom data in key-value pairs." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - }, - { - "id": 5279, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the product image." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5281, - 5278, - 5280, - 5279 - ] - } - ] - }, - { - "id": 5236, - "name": "ProductOptionDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A product option's data." - } - ] - }, - "children": [ - { - "id": 5242, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product option was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 5237, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5241, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Holds custom data in key-value pairs." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - }, - { - "id": 5239, - "name": "product", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "reference", - "target": 5150, - "name": "ProductDTO", - "package": "@medusajs/types" - } - }, - { - "id": 5238, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The title of the product option." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5240, - "name": "values", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product option values." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5143, - "name": "ProductOptionValueDTO", - "package": "@medusajs/types" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5242, - 5237, - 5241, - 5239, - 5238, - 5240 - ] - } - ] - }, - { - "id": 5143, - "name": "ProductOptionValueDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product option value's data." - } - ] - }, - "children": [ - { - "id": 5149, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product option value was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 5144, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product option value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5148, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Holds custom data in key-value pairs." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - }, - { - "id": 5146, - "name": "option", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product option. It may only be available if the " - }, - { - "kind": "code", - "text": "`option`" - }, - { - "kind": "text", - "text": " relation is expanded." - } - ] - }, - "type": { - "type": "reference", - "target": 5236, - "name": "ProductOptionDTO", - "package": "@medusajs/types" - } - }, - { - "id": 5145, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the product option value." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5147, - "name": "variant", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product variant. It may only be available if the " - }, - { - "kind": "code", - "text": "`variant`" - }, - { - "kind": "text", - "text": " relation is expanded." - } - ] - }, - "type": { - "type": "reference", - "target": 4981, - "name": "ProductVariantDTO", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5149, - 5144, - 5148, - 5146, - 5145, - 5147 - ] - } - ] - }, - { - "id": 5272, - "name": "ProductTagDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A product tag's data." - } - ] - }, - "children": [ - { - "id": 5273, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product tag." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5275, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Holds custom data in key-value pairs." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - }, - { - "id": 5276, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated products." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5150, - "name": "ProductDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 5274, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the product tag." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5273, - 5275, - 5276, - 5274 - ] - } - ] - }, - { - "id": 5267, - "name": "ProductTypeDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A product type's data." - } - ] - }, - "children": [ - { - "id": 5271, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product type was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 5268, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product type." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5270, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Holds custom data in key-value pairs." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - }, - { - "id": 5269, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the product type." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5271, - 5268, - 5270, - 5269 - ] - } - ] - }, - { - "id": 4981, - "name": "ProductVariantDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A product variant's data." - } - ] - }, - "children": [ - { - "id": 4989, - "name": "allow_backorder", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the product variant can be ordered when it's out of stock." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4985, - "name": "barcode", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The barcode of the product variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5004, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product variant was created." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 5006, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product variant was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 4986, - "name": "ean", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The EAN of the product variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 4997, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the product variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 4991, - "name": "hs_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The HS Code of the product variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 4982, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4988, - "name": "inventory_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The inventory quantiy of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4996, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The length of the product variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 4990, - "name": "manage_inventory", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the product variant's inventory should be managed by the core system." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4994, - "name": "material", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The material of the product variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5000, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Holds custom data in key-value pairs." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - }, - { - "id": 4993, - "name": "mid_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The MID Code of the product variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 4999, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product options." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5143, - "name": "ProductOptionValueDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 4992, - "name": "origin_country", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The origin country of the product variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5001, - "name": "product", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated product." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "reference", - "target": 5150, - "name": "ProductDTO", - "package": "@medusajs/types" - } - }, - { - "id": 5002, - "name": "product_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4984, - "name": "sku", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The SKU of the product variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 4983, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tile of the product variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4987, - "name": "upc", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The UPC of the product variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 5005, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the product variant was updated." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 5003, - "name": "variant_rank", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "he ranking of the variant among other variants associated with the product." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 4995, - "name": "weight", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The weight of the product variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 4998, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the product variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4989, - 4985, - 5004, - 5006, - 4986, - 4997, - 4991, - 4982, - 4988, - 4996, - 4990, - 4994, - 5000, - 4993, - 4999, - 4992, - 5001, - 5002, - 4984, - 4983, - 4987, - 5005, - 5003, - 4995, - 4998 - ] - } - ] - }, - { - "id": 3894, - "name": "RequestQueryFields", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Request parameters used to configure and paginate retrieved data." - } - ] - }, - "children": [ - { - "id": 3895, + "id": 292, "name": "expand", "variant": "declaration", "kind": 1024, @@ -89037,10 +9478,15 @@ "type": { "type": "intrinsic", "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" } }, { - "id": 3896, + "id": 293, "name": "fields", "variant": "declaration", "kind": 1024, @@ -89058,1115 +9504,401 @@ "type": { "type": "intrinsic", "name": "string" - } - }, - { - "id": 3898, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Limit the number of items returned in the list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3897, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of items to skip when retrieving a list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3899, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " - }, - { - "kind": "code", - "text": "`-`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" } } ], "groups": [ { - "title": "Properties", + "title": "Constructors", "children": [ - 3895, - 3896, - 3898, - 3897, - 3899 + 290 ] - } - ] - }, - { - "id": 4974, - "name": "SubscriberContext", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 4975, - "name": "subscriberId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ + }, { "title": "Properties", "children": [ - 4975 + 292, + 293 ] } ], "extendedTypes": [ { "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" } ] }, { - "id": 4, - "name": "AdminAnalyticsConfigDeleteRes", + "id": 299, + "name": "AdminGetDiscountsDiscountCodeParams", "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 1, - "name": "AdminAnalyticsConfigRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3, - "name": "analytics_config", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/analytics-config.ts", - "qualifiedName": "AnalyticsConfig" - }, - "name": "AnalyticsConfig", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3 - ] - } - ] - } - } - }, - { - "id": 15, - "name": "AdminAuthRes", - "variant": "declaration", - "kind": 2097152, + "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The user's details." + "text": "Parameters that can be used to configure how data is retrieved." } - ], - "modifierTags": [ - "@interface" ] }, - "type": { - "type": "reflection", - "declaration": { - "id": 16, - "name": "__type", + "children": [ + { + "id": 300, + "name": "constructor", "variant": "declaration", - "kind": 65536, + "kind": 512, "flags": {}, - "children": [ + "signatures": [ { - "id": 17, - "name": "user", - "variant": "declaration", - "kind": 1024, + "id": 301, + "name": "new AdminGetDiscountsDiscountCodeParams", + "variant": "signature", + "kind": 16384, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User details." - } - ] - }, "type": { "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/user.ts", - "qualifiedName": "User" - }, - "name": "User", - "package": "@medusajs/medusa" - }, - { - "type": "literal", - "value": "password_hash" - } - ], - "name": "Omit", - "package": "typescript" + "target": 299, + "name": "AdminGetDiscountsDiscountCodeParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" } } ], - "groups": [ - { - "title": "Properties", - "children": [ - 17 - ] - } - ] - } - } - }, - { - "id": 29, - "name": "AdminBatchJobListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { + "inheritedFrom": { "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 302, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, - { - "type": "reflection", - "declaration": { - "id": 30, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 31, - "name": "batch_jobs", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of batch job details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/batch-job.ts", - "qualifiedName": "BatchJob" - }, - "name": "BatchJob", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 31 - ] - } - ] - } - } - ] - } - }, - { - "id": 26, - "name": "AdminBatchJobRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The batch job's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 27, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 28, - "name": "batch_job", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Batch job details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/batch-job.ts", - "qualifiedName": "BatchJob" - }, - "name": "BatchJob", - "package": "@medusajs/medusa" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 28 - ] - } - ] - } - } - }, - { - "id": 18, - "name": "AdminBearerAuthRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The access token of the user, if they're authenticated successfully." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 19, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 20, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access token that can be used to send authenticated requests." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 20 - ] - } - ] - } - } - }, - { - "id": 69, - "name": "AdminCollectionsDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 66, - "name": "AdminCollectionsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 67, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 68, - "name": "collections", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "an array of collection details" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-collection.ts", - "qualifiedName": "ProductCollection" - }, - "name": "ProductCollection", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 68 - ] - } - ] - } + "target": 3973, + "name": "FindParams.expand" } - ] - } - }, - { - "id": 75, - "name": "AdminCollectionsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The collection's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 76, - "name": "__type", + }, + { + "id": 303, + "name": "fields", "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 77, - "name": "collection", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product Collection details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-collection.ts", - "qualifiedName": "ProductCollection" - }, - "name": "ProductCollection", - "package": "@medusajs/medusa" + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 77 - ] - } - ] - } - } - }, - { - "id": 115, - "name": "AdminCurrenciesListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "List of currencies with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 116, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 117, - "name": "currencies", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of currency details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/currency.ts", - "qualifiedName": "Currency" - }, - "name": "Currency", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 117 - ] - } - ] - } + "target": 3974, + "name": "FindParams.fields" } - ] - } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 300 + ] + }, + { + "title": "Properties", + "children": [ + 302, + 303 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] }, { - "id": 118, - "name": "AdminCurrenciesRes", + "id": 294, + "name": "AdminGetDiscountParams", "variant": "declaration", - "kind": 2097152, + "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A currency's details." + "text": "Parameters that can be used to configure how data is retrieved." } - ], - "modifierTags": [ - "@interface" ] }, - "type": { - "type": "reflection", - "declaration": { - "id": 119, - "name": "__type", + "children": [ + { + "id": 295, + "name": "constructor", "variant": "declaration", - "kind": 65536, + "kind": 512, "flags": {}, - "children": [ + "signatures": [ { - "id": 120, - "name": "currency", - "variant": "declaration", - "kind": 1024, + "id": 296, + "name": "new AdminGetDiscountParams", + "variant": "signature", + "kind": 16384, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Currency details." - } - ] - }, "type": { "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/currency.ts", - "qualifiedName": "Currency" - }, - "name": "Currency", + "target": 294, + "name": "AdminGetDiscountParams", "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" } } ], - "groups": [ - { - "title": "Properties", - "children": [ - 120 - ] - } - ] - } - } - }, - { - "id": 136, - "name": "AdminCustomerGroupsDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 137, - "name": "AdminCustomerGroupsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { + "inheritedFrom": { "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 138, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 139, - "name": "customer_groups", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of customer group details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer-group.ts", - "qualifiedName": "CustomerGroup" - }, - "name": "CustomerGroup", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 139 - ] - } - ] - } + "target": 3971, + "name": "FindParams.constructor" } - ] - } - }, - { - "id": 133, - "name": "AdminCustomerGroupsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer group's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 134, - "name": "__type", + }, + { + "id": 297, + "name": "expand", "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 135, - "name": "customer_group", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Customer group details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer-group.ts", - "qualifiedName": "CustomerGroup" - }, - "name": "CustomerGroup", - "package": "@medusajs/medusa" + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 135 - ] - } - ] - } - } - }, - { - "id": 180, - "name": "AdminCustomersListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of customers with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 181, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 182, - "name": "customers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of customer details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer.ts", - "qualifiedName": "Customer" - }, - "name": "Customer", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 182 - ] - } - ] - } + "target": 3973, + "name": "FindParams.expand" } - ] - } - }, - { - "id": 177, - "name": "AdminCustomersRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 178, - "name": "__type", + }, + { + "id": 298, + "name": "fields", "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 179, - "name": "customer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Customer details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer.ts", - "qualifiedName": "Customer" - }, - "name": "Customer", - "package": "@medusajs/medusa" + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 179 - ] - } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 295 + ] + }, + { + "title": "Properties", + "children": [ + 297, + 298 ] } - } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] }, { - "id": 70, - "name": "AdminDeleteProductsFromCollectionRes", + "id": 212, + "name": "defaultAdminDiscountsFields", "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Deletion operation details" - } - ], - "modifierTags": [ - "@interface" - ] + "kind": 32, + "flags": { + "isConst": true }, "type": { - "type": "reflection", - "declaration": { - "id": 71, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 72, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the collection" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } + "type": "array", + "elementType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/discount.ts", + "qualifiedName": "Discount" }, - { - "id": 73, - "name": "object", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of object the removal was executed on" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "product-collection" + "name": "Discount", + "package": "@medusajs/medusa" + } + } + }, + "defaultValue": "..." + }, + { + "id": 213, + "name": "defaultAdminDiscountsRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 214, + "name": "defaultAdminDiscountConditionFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/discount-condition.ts", + "qualifiedName": "DiscountCondition" }, + "name": "DiscountCondition", + "package": "@medusajs/medusa" + } + } + }, + "defaultValue": "..." + }, + { + "id": 215, + "name": "defaultAdminDiscountConditionRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 216, + "name": "AdminDiscountsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 217, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ { - "id": 74, - "name": "removed_products", + "id": 218, + "name": "discount", "variant": "declaration", "kind": 1024, "flags": {}, @@ -90174,16 +9906,18 @@ "summary": [ { "kind": "text", - "text": "The IDs of the products removed from the collection" + "text": "Discount details." } ] }, "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/discount.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" } } ], @@ -90191,140 +9925,13 @@ { "title": "Properties", "children": [ - 72, - 73, - 74 + 218 ] } ] } } }, - { - "id": 1789, - "name": "AdminDeleteShippingProfileRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 2008, - "name": "AdminDeleteUploadsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 2034, - "name": "AdminDeleteUserRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 223, - "name": "AdminDiscountConditionsDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 224, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 225, - "name": "discount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Discount to which the condition used to belong to." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/discount.ts", - "qualifiedName": "Discount" - }, - "name": "Discount", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 225 - ] - } - ] - } - } - ] - } - }, { "id": 219, "name": "AdminDiscountConditionsRes", @@ -90396,11 +10003,79 @@ }, "type": { "type": "reference", - "target": 3904, + "target": 3911, "name": "DeleteResponse", "package": "@medusajs/medusa" } }, + { + "id": 223, + "name": "AdminDiscountConditionsDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 224, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 225, + "name": "discount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Discount to which the condition used to belong to." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/discount.ts", + "qualifiedName": "Discount" + }, + "name": "Discount", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 225 + ] + } + ] + } + } + ] + } + }, { "id": 226, "name": "AdminDiscountsListRes", @@ -90423,7 +10098,7 @@ "types": [ { "type": "reference", - "target": 3900, + "target": 3907, "name": "PaginatedResponse", "package": "@medusajs/medusa" }, @@ -90478,8 +10153,2641 @@ } }, { - "id": 216, - "name": "AdminDiscountsRes", + "id": 304, + "name": "AdminGetDiscountsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved discounts." + } + ] + }, + "children": [ + { + "id": 308, + "name": "rule", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter discounts by their associated rule." + } + ] + }, + "type": { + "type": "reference", + "target": 4366, + "name": "AdminGetDiscountsDiscountRuleParams", + "package": "@medusajs/medusa" + } + }, + { + "id": 309, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search terms to search discounts' code fields." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 310, + "name": "is_dynamic", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter discounts by whether they're dynamic." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 311, + "name": "is_disabled", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter discounts by whether they're disabled." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 312, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).expand" + } + }, + { + "id": 313, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).fields" + } + }, + { + "id": 314, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).offset" + } + }, + { + "id": 315, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).limit" + } + }, + { + "id": 305, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 306, + "name": "new AdminGetDiscountsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 307, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 304, + "name": "AdminGetDiscountsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 305 + ] + }, + { + "title": "Properties", + "children": [ + 308, + 309, + 310, + 311, + 312, + 313, + 314, + 315 + ] + } + ], + "extendedTypes": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ] + }, + { + "id": 316, + "name": "AdminPostDiscountsDiscountConditionsCondition", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 317, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 318, + "name": "new AdminPostDiscountsDiscountConditionsCondition", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 316, + "name": "AdminPostDiscountsDiscountConditionsCondition", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4360, + "name": "AdminUpsertConditionsReq.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4359, + "name": "AdminUpsertConditionsReq.constructor" + } + }, + { + "id": 319, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The products associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4361, + "name": "AdminUpsertConditionsReq.products" + } + }, + { + "id": 320, + "name": "product_collections", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collections associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_collections`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4362, + "name": "AdminUpsertConditionsReq.product_collections" + } + }, + { + "id": 321, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product types associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_types`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4363, + "name": "AdminUpsertConditionsReq.product_types" + } + }, + { + "id": 322, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product tags associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_tags`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4364, + "name": "AdminUpsertConditionsReq.product_tags" + } + }, + { + "id": 323, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer groups associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`customer_groups`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4365, + "name": "AdminUpsertConditionsReq.customer_groups" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 317 + ] + }, + { + "title": "Properties", + "children": [ + 319, + 320, + 321, + 322, + 323 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4358, + "name": "AdminUpsertConditionsReq", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 324, + "name": "AdminPostDiscountsDiscountConditionsConditionParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 325, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 326, + "name": "new AdminPostDiscountsDiscountConditionsConditionParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 324, + "name": "AdminPostDiscountsDiscountConditionsConditionParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 327, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 328, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 325 + ] + }, + { + "title": "Properties", + "children": [ + 327, + 328 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 329, + "name": "AdminPostDiscountsDiscountReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the discount to update." + } + ] + }, + "children": [ + { + "id": 330, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 331, + "name": "new AdminPostDiscountsDiscountReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the discount to update." + } + ] + }, + "type": { + "type": "reference", + "target": 329, + "name": "AdminPostDiscountsDiscountReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 332, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique code that will be used to redeem the discount" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 333, + "name": "rule", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount rule that defines how discounts are calculated" + } + ] + }, + "type": { + "type": "reference", + "target": 341, + "name": "AdminUpdateDiscountRule", + "package": "@medusajs/medusa" + } + }, + { + "id": 334, + "name": "is_disabled", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the discount code is disabled on creation. If set to `true`, it will not be available for customers." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 335, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date and time at which the discount should be available." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 336, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date and time at which the discount should no longer be available." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 337, + "name": "valid_duration", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The duration the discount runs between" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 338, + "name": "usage_limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Maximum number of times the discount can be used" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 339, + "name": "regions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of region IDs representing the Regions in which the Discount can be used." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 340, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object containing metadata of the discount" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 330 + ] + }, + { + "title": "Properties", + "children": [ + 332, + 333, + 334, + 335, + 336, + 337, + 338, + 339, + 340 + ] + } + ] + }, + { + "id": 341, + "name": "AdminUpdateDiscountRule", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attributes of the discount rule to update." + } + ] + }, + "children": [ + { + "id": 342, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 343, + "name": "new AdminUpdateDiscountRule", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 341, + "name": "AdminUpdateDiscountRule", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 344, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount rule's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 345, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount rule's description." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 346, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount rule's value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 347, + "name": "allocation", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount rule's allocation." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/discount-rule.ts", + "qualifiedName": "AllocationType" + }, + "name": "AllocationType", + "package": "@medusajs/medusa" + } + }, + { + "id": 348, + "name": "conditions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount rule's discount conditions." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 349, + "name": "AdminUpsertCondition", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 342 + ] + }, + { + "title": "Properties", + "children": [ + 344, + 345, + 346, + 347, + 348 + ] + } + ] + }, + { + "id": 349, + "name": "AdminUpsertCondition", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attributes to create or update in the discount condition." + } + ] + }, + "children": [ + { + "id": 350, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 351, + "name": "new AdminUpsertCondition", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 349, + "name": "AdminUpsertCondition", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4360, + "name": "AdminUpsertConditionsReq.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4359, + "name": "AdminUpsertConditionsReq.constructor" + } + }, + { + "id": 352, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount condition's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 353, + "name": "operator", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount condition's operator." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/discount-condition.ts", + "qualifiedName": "DiscountConditionOperator" + }, + "name": "DiscountConditionOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 354, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The products associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4361, + "name": "AdminUpsertConditionsReq.products" + } + }, + { + "id": 355, + "name": "product_collections", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collections associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_collections`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4362, + "name": "AdminUpsertConditionsReq.product_collections" + } + }, + { + "id": 356, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product types associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_types`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4363, + "name": "AdminUpsertConditionsReq.product_types" + } + }, + { + "id": 357, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product tags associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_tags`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4364, + "name": "AdminUpsertConditionsReq.product_tags" + } + }, + { + "id": 358, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer groups associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`customer_groups`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4365, + "name": "AdminUpsertConditionsReq.customer_groups" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 350 + ] + }, + { + "title": "Properties", + "children": [ + 352, + 353, + 354, + 355, + 356, + 357, + 358 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4358, + "name": "AdminUpsertConditionsReq", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 359, + "name": "AdminPostDiscountsDiscountParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 360, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 361, + "name": "new AdminPostDiscountsDiscountParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 359, + "name": "AdminPostDiscountsDiscountParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 362, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 363, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 360 + ] + }, + { + "title": "Properties", + "children": [ + 362, + 363 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 400, + "name": "AdminPostDraftOrdersReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the draft order to create." + } + ] + }, + "children": [ + { + "id": 401, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 402, + "name": "new AdminPostDraftOrdersReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the draft order to create." + } + ] + }, + "type": { + "type": "reference", + "target": 400, + "name": "AdminPostDraftOrdersReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 403, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The status of the draft order. The draft order's default status is `open`. It's changed to `completed` when its payment is marked as paid." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 404, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The email of the customer of the draft order" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 405, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Address to be used for billing purposes." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 3942, + "name": "AddressPayload", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 406, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Address to be used for shipping purposes." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 3942, + "name": "AddressPayload", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 407, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The draft order's line items." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4371, + "name": "Item", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 408, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the region for the draft order" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 409, + "name": "discounts", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discounts to add to the draft order" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4379, + "name": "Discount", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 410, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the customer this draft order is associated with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 411, + "name": "no_notification_order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 412, + "name": "shipping_methods", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping methods for the draft order" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4383, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 413, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The optional key-value map with additional details about the Draft Order." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "defaultValue": "{}" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 401 + ] + }, + { + "title": "Properties", + "children": [ + 403, + 404, + 405, + 406, + 407, + 408, + 409, + 410, + 411, + 412, + 413 + ] + } + ] + }, + { + "id": 4383, + "name": "ShippingMethod", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." + } + ] + }, + "children": [ + { + "id": 4384, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4385, + "name": "new ShippingMethod", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." + } + ] + }, + "type": { + "type": "reference", + "target": 4383, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4386, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the shipping option in use" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4387, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The optional additional data needed for the shipping method" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "defaultValue": "{}" + }, + { + "id": 4388, + "name": "price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price of the shipping method." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4384 + ] + }, + { + "title": "Properties", + "children": [ + 4386, + 4387, + 4388 + ] + } + ] + }, + { + "id": 4379, + "name": "Discount", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A discount can be applied to a cart for promotional purposes." + } + ] + }, + "children": [ + { + "id": 4380, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4381, + "name": "new Discount", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A discount can be applied to a cart for promotional purposes." + } + ] + }, + "type": { + "type": "reference", + "target": 4379, + "name": "Discount", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4382, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the discount to apply" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4380 + ] + }, + { + "title": "Properties", + "children": [ + 4382 + ] + } + ] + }, + { + "id": 4371, + "name": "Item", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4372, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4373, + "name": "new Item", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4371, + "name": "Item", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4374, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the line item if `variant_id` is not provided." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4375, + "name": "unit_price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The custom price of the line item. If a `variant_id` is supplied, the price provided here will override the variant's price." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4376, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Product Variant associated with the line item. If the line item is custom, the `variant_id` should be omitted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4377, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4378, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The optional key-value map with additional details about the line item." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "defaultValue": "{}" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4372 + ] + }, + { + "title": "Properties", + "children": [ + 4374, + 4375, + 4376, + 4377, + 4378 + ] + } + ] + }, + { + "id": 414, + "name": "AdminPostDraftOrdersDraftOrderLineItemsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the line item to create." + } + ] + }, + "children": [ + { + "id": 415, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 416, + "name": "new AdminPostDraftOrdersDraftOrderLineItemsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the line item to create." + } + ] + }, + "type": { + "type": "reference", + "target": 414, + "name": "AdminPostDraftOrdersDraftOrderLineItemsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 417, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the line item if `variant_id` is not provided." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "\"Custom item\"" + }, + { + "id": 418, + "name": "unit_price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The custom price of the line item. If a `variant_id` is supplied, the price provided here will override the variant's price." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 419, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Product Variant associated with the line item. If the line item is custom, the `variant_id` should be omitted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 420, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 421, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The optional key-value map with additional details about the Line Item." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "defaultValue": "{}" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 415 + ] + }, + { + "title": "Properties", + "children": [ + 417, + 418, + 419, + 420, + 421 + ] + } + ] + }, + { + "id": 386, + "name": "defaultAdminDraftOrdersRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 387, + "name": "defaultAdminDraftOrdersCartRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 388, + "name": "defaultAdminDraftOrdersCartFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + } + } + }, + "defaultValue": "..." + }, + { + "id": 389, + "name": "defaultAdminDraftOrdersFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/draft-order.ts", + "qualifiedName": "DraftOrder" + }, + "name": "DraftOrder", + "package": "@medusajs/medusa" + } + } + }, + "defaultValue": "..." + }, + { + "id": 390, + "name": "AdminPostDraftOrdersDraftOrderRegisterPaymentRes", "variant": "declaration", "kind": 2097152, "flags": {}, @@ -90487,7 +12795,7 @@ "summary": [ { "kind": "text", - "text": "The discount's details." + "text": "The order's details." } ], "modifierTags": [ @@ -90497,15 +12805,15 @@ "type": { "type": "reflection", "declaration": { - "id": 217, + "id": 391, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 218, - "name": "discount", + "id": 392, + "name": "order", "variant": "declaration", "kind": 1024, "flags": {}, @@ -90513,17 +12821,17 @@ "summary": [ { "kind": "text", - "text": "Discount details." + "text": "Order's details." } ] }, "type": { "type": "reference", "target": { - "sourceFileName": "../../../packages/medusa/src/models/discount.ts", - "qualifiedName": "Discount" + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" }, - "name": "Discount", + "name": "Order", "package": "@medusajs/medusa" } } @@ -90532,108 +12840,13 @@ { "title": "Properties", "children": [ - 218 + 392 ] } ] } } }, - { - "id": 396, - "name": "AdminDraftOrdersDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 397, - "name": "AdminDraftOrdersListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of draft orders with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 398, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 399, - "name": "draft_orders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of draft order's details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/draft-order.ts", - "qualifiedName": "DraftOrder" - }, - "name": "DraftOrder", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 399 - ] - } - ] - } - } - ] - } - }, { "id": 393, "name": "AdminDraftOrdersRes", @@ -90697,126 +12910,8 @@ } }, { - "id": 1861, - "name": "AdminExtendedStoresRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The store's details with additional details like payment and tax providers." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1862, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1863, - "name": "store", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Store details." - } - ] - }, - "type": { - "type": "reference", - "target": 4753, - "name": "ExtendedStoreDTO", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1863 - ] - } - ] - } - } - }, - { - "id": 2109, - "name": "AdminGetVariantsVariantInventoryRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The variant's inventory details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2110, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2111, - "name": "variant", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product variant's inventory details." - } - ] - }, - "type": { - "type": "reference", - "target": 2100, - "name": "VariantInventory", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2111 - ] - } - ] - } - } - }, - { - "id": 458, - "name": "AdminGiftCardsDeleteRes", + "id": 396, + "name": "AdminDraftOrdersDeleteRes", "variant": "declaration", "kind": 2097152, "flags": {}, @@ -90828,14 +12923,14 @@ }, "type": { "type": "reference", - "target": 3904, + "target": 3911, "name": "DeleteResponse", "package": "@medusajs/medusa" } }, { - "id": 459, - "name": "AdminGiftCardsListRes", + "id": 397, + "name": "AdminDraftOrdersListRes", "variant": "declaration", "kind": 2097152, "flags": {}, @@ -90843,7 +12938,7 @@ "summary": [ { "kind": "text", - "text": "The list of gift cards with pagination fields." + "text": "The list of draft orders with pagination fields." } ], "modifierTags": [ @@ -90855,22 +12950,22 @@ "types": [ { "type": "reference", - "target": 3900, + "target": 3907, "name": "PaginatedResponse", "package": "@medusajs/medusa" }, { "type": "reflection", "declaration": { - "id": 460, + "id": 398, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 461, - "name": "gift_cards", + "id": 399, + "name": "draft_orders", "variant": "declaration", "kind": 1024, "flags": {}, @@ -90878,7 +12973,7 @@ "summary": [ { "kind": "text", - "text": "The list of gift cards." + "text": "An array of draft order's details." } ] }, @@ -90887,10 +12982,10 @@ "elementType": { "type": "reference", "target": { - "sourceFileName": "../../../packages/medusa/src/models/gift-card.ts", - "qualifiedName": "GiftCard" + "sourceFileName": "../../../packages/medusa/src/models/draft-order.ts", + "qualifiedName": "DraftOrder" }, - "name": "GiftCard", + "name": "DraftOrder", "package": "@medusajs/medusa" } } @@ -90900,7 +12995,7 @@ { "title": "Properties", "children": [ - 461 + 399 ] } ] @@ -90909,6 +13004,978 @@ ] } }, + { + "id": 422, + "name": "AdminGetDraftOrdersParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved draft orders." + } + ] + }, + "children": [ + { + "id": 423, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 424, + "name": "new AdminGetDraftOrdersParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 422, + "name": "AdminGetDraftOrdersParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 425, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search draft orders by their display IDs and emails." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 426, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "50" + }, + { + "id": 427, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 423 + ] + }, + { + "title": "Properties", + "children": [ + 425, + 426, + 427 + ] + } + ] + }, + { + "id": 428, + "name": "reserveQuantityForDraftOrder", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 429, + "name": "reserveQuantityForDraftOrder", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 430, + "name": "order", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 431, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 432, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 433, + "name": "productVariantInventoryService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", + "qualifiedName": "ProductVariantInventoryService" + }, + "name": "ProductVariantInventoryService", + "package": "@medusajs/medusa" + } + }, + { + "id": 434, + "name": "locationId", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 433, + 434 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 435, + "name": "AdminPostDraftOrdersDraftOrderReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the draft order to update." + } + ] + }, + "children": [ + { + "id": 436, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 437, + "name": "new AdminPostDraftOrdersDraftOrderReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the draft order to update." + } + ] + }, + "type": { + "type": "reference", + "target": 435, + "name": "AdminPostDraftOrdersDraftOrderReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 438, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Region to create the Draft Order in." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 439, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The 2 character ISO code for the Country." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 440, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An email to be used in the Draft Order." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 441, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Address to be used for billing purposes." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 3942, + "name": "AddressPayload", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 442, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Address to be used for shipping purposes." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 3942, + "name": "AddressPayload", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 443, + "name": "discounts", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of Discount codes to add to the Draft Order." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4389, + "name": "Discount", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 444, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the customer this draft order is associated with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 445, + "name": "no_notification_order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 436 + ] + }, + { + "title": "Properties", + "children": [ + 438, + 439, + 440, + 441, + 442, + 443, + 444, + 445 + ] + } + ] + }, + { + "id": 4389, + "name": "Discount", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A discount can be applied to a cart for promotional purposes." + } + ] + }, + "children": [ + { + "id": 4390, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4391, + "name": "new Discount", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A discount can be applied to a cart for promotional purposes." + } + ] + }, + "type": { + "type": "reference", + "target": 4389, + "name": "Discount", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4392, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code that a Discount is identifed by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4390 + ] + }, + { + "title": "Properties", + "children": [ + 4392 + ] + } + ] + }, + { + "id": 446, + "name": "AdminPostDraftOrdersDraftOrderLineItemsItemReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the line item." + } + ] + }, + "children": [ + { + "id": 447, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 448, + "name": "new AdminPostDraftOrdersDraftOrderLineItemsItemReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the line item." + } + ] + }, + "type": { + "type": "reference", + "target": 446, + "name": "AdminPostDraftOrdersDraftOrderLineItemsItemReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 449, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the line item if `variant_id` is not provided." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 450, + "name": "unit_price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The custom price of the line item. If a `variant_id` is supplied, the price provided here will override the variant's price." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 451, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 452, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The optional key-value map with additional details about the Line Item." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "defaultValue": "{}" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 447 + ] + }, + { + "title": "Properties", + "children": [ + 449, + 450, + 451, + 452 + ] + } + ] + }, + { + "id": 462, + "name": "AdminPostGiftCardsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the gift card to create." + } + ] + }, + "children": [ + { + "id": 463, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 464, + "name": "new AdminPostGiftCardsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the gift card to create." + } + ] + }, + "type": { + "type": "reference", + "target": 462, + "name": "AdminPostGiftCardsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 465, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value (excluding VAT) that the Gift Card should represent." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 466, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date and time at which the Gift Card should no longer be available." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 467, + "name": "is_disabled", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Gift Card is disabled on creation. If set to `true`, the gift card will not be available for customers." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 468, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Region in which the Gift Card can be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 469, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 463 + ] + }, + { + "title": "Properties", + "children": [ + 465, + 466, + 467, + 468, + 469 + ] + } + ] + }, + { + "id": 453, + "name": "defaultAdminGiftCardFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/gift-card.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + } + }, + "defaultValue": "..." + }, + { + "id": 454, + "name": "defaultAdminGiftCardRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, { "id": 455, "name": "AdminGiftCardsRes", @@ -90971,6 +14038,1435 @@ } } }, + { + "id": 458, + "name": "AdminGiftCardsDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 459, + "name": "AdminGiftCardsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of gift cards with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 460, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 461, + "name": "gift_cards", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of gift cards." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/gift-card.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 461 + ] + } + ] + } + } + ] + } + }, + { + "id": 470, + "name": "AdminGetGiftCardsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved gift cards." + } + ] + }, + "children": [ + { + "id": 471, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 472, + "name": "new AdminGetGiftCardsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 470, + "name": "AdminGetGiftCardsParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 473, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n50\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "50" + }, + { + "id": 474, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 475, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search gift cards by their code and display ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 471 + ] + }, + { + "title": "Properties", + "children": [ + 473, + 474, + 475 + ] + } + ] + }, + { + "id": 476, + "name": "AdminPostGiftCardsGiftCardReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the gift card." + } + ] + }, + "children": [ + { + "id": 477, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 478, + "name": "new AdminPostGiftCardsGiftCardReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the gift card." + } + ] + }, + "type": { + "type": "reference", + "target": 476, + "name": "AdminPostGiftCardsGiftCardReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 479, + "name": "balance", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value (excluding VAT) that the Gift Card should represent." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 480, + "name": "is_disabled", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Gift Card is disabled on creation. If set to `true`, the gift card will not be available for customers." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 481, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date and time at which the Gift Card should no longer be available." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 482, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Region in which the Gift Card can be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 483, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 477 + ] + }, + { + "title": "Properties", + "children": [ + 479, + 480, + 481, + 482, + 483 + ] + } + ] + }, + { + "id": 509, + "name": "AdminPostInventoryItemsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the inventory item to create." + } + ] + }, + "children": [ + { + "id": 510, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 511, + "name": "new AdminPostInventoryItemsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the inventory item to create." + } + ] + }, + "type": { + "type": "reference", + "target": 509, + "name": "AdminPostInventoryItemsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 512, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the variant to create the inventory item for." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 513, + "name": "sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique SKU of the associated Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 514, + "name": "hs_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 515, + "name": "weight", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The weight of the Inventory Item. May be used in shipping rate calculations." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 516, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The length of the Inventory Item. May be used in shipping rate calculations." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 517, + "name": "height", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the Inventory Item. May be used in shipping rate calculations." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 518, + "name": "width", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The width of the Inventory Item. May be used in shipping rate calculations." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 519, + "name": "origin_country", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 520, + "name": "mid_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "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": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 521, + "name": "material", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "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": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 522, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's title." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 523, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's description." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 524, + "name": "thumbnail", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's thumbnail." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 525, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 510 + ] + }, + { + "title": "Properties", + "children": [ + 512, + 513, + 514, + 515, + 516, + 517, + 518, + 519, + 520, + 521, + 522, + 523, + 524, + 525 + ] + } + ] + }, + { + "id": 526, + "name": "AdminPostInventoryItemsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 527, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 528, + "name": "new AdminPostInventoryItemsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 526, + "name": "AdminPostInventoryItemsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 529, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 530, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 527 + ] + }, + { + "title": "Properties", + "children": [ + 529, + 530 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 531, + "name": "AdminPostInventoryItemsItemLocationLevelsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the location level to create." + } + ] + }, + "children": [ + { + "id": 532, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 533, + "name": "new AdminPostInventoryItemsItemLocationLevelsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the location level to create." + } + ] + }, + "type": { + "type": "reference", + "target": 531, + "name": "AdminPostInventoryItemsItemLocationLevelsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 534, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the ID of the stock location" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 535, + "name": "stocked_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the stock quantity of the inventory item at this location" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 536, + "name": "incoming_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the incoming stock quantity of the inventory item at this location" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 532 + ] + }, + { + "title": "Properties", + "children": [ + 534, + 535, + 536 + ] + } + ] + }, + { + "id": 537, + "name": "AdminPostInventoryItemsItemLocationLevelsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 538, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 539, + "name": "new AdminPostInventoryItemsItemLocationLevelsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 537, + "name": "AdminPostInventoryItemsItemLocationLevelsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 540, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 541, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 538 + ] + }, + { + "title": "Properties", + "children": [ + 540, + 541 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 542, + "name": "AdminGetInventoryItemsItemParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 543, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 544, + "name": "new AdminGetInventoryItemsItemParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 542, + "name": "AdminGetInventoryItemsItemParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 545, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 546, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 543 + ] + }, + { + "title": "Properties", + "children": [ + 545, + 546 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 484, + "name": "defaultAdminInventoryItemFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 4393, + "name": "InventoryItemDTO", + "package": "@medusajs/types" + } + } + }, + "defaultValue": "..." + }, + { + "id": 485, + "name": "defaultAdminLocationLevelFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 4413, + "name": "InventoryLevelDTO", + "package": "@medusajs/types" + } + } + }, + "defaultValue": "..." + }, + { + "id": 486, + "name": "defaultAdminInventoryItemRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "never" + } + }, + "defaultValue": "[]" + }, + { + "id": 487, + "name": "AdminInventoryItemsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 488, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 489, + "name": "inventory_item", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Inventory Item details" + } + ] + }, + "type": { + "type": "reference", + "target": 4393, + "name": "InventoryItemDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 489 + ] + } + ] + } + } + }, { "id": 490, "name": "AdminInventoryItemsDeleteRes", @@ -90985,7 +15481,7 @@ }, "type": { "type": "reference", - "target": 3904, + "target": 3911, "name": "DeleteResponse", "package": "@medusajs/medusa" } @@ -91007,7 +15503,7 @@ "types": [ { "type": "reference", - "target": 3900, + "target": 3907, "name": "PaginatedResponse", "package": "@medusajs/medusa" }, @@ -91038,7 +15534,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 4386, + "target": 4393, "name": "InventoryItemDTO", "package": "@medusajs/types" } @@ -91058,6 +15554,146 @@ ] } }, + { + "id": 494, + "name": "DecoratedInventoryItemDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 4393, + "name": "InventoryItemDTO", + "package": "@medusajs/types" + }, + { + "type": "reflection", + "declaration": { + "id": 495, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 496, + "name": "location_levels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of location level details" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4413, + "name": "InventoryLevelDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 497, + "name": "variants", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product variant details" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-variant.ts", + "qualifiedName": "ProductVariant" + }, + "name": "ProductVariant", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 498, + "name": "stocked_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total quantity of the item in stock across levels" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 499, + "name": "reserved_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total quantity of the item available across levels" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 496, + 497, + 498, + 499 + ] + } + ] + } + } + ] + } + }, { "id": 500, "name": "AdminInventoryItemsListWithVariantsAndLocationLevelsRes", @@ -91075,7 +15711,7 @@ "types": [ { "type": "reference", - "target": 3900, + "target": 3907, "name": "PaginatedResponse", "package": "@medusajs/medusa" }, @@ -91212,7 +15848,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 4406, + "target": 4413, "name": "InventoryLevelDTO", "package": "@medusajs/types" } @@ -91244,63 +15880,1866 @@ } }, { - "id": 487, - "name": "AdminInventoryItemsRes", + "id": 547, + "name": "AdminGetInventoryItemsParams", "variant": "declaration", - "kind": 2097152, + "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The inventory item's details." + "text": "Parameters used to filter and configure the pagination of the retrieved inventory items." } - ], - "modifierTags": [ - "@interface" ] }, - "type": { - "type": "reflection", - "declaration": { - "id": 488, - "name": "__type", + "children": [ + { + "id": 551, + "name": "id", "variant": "declaration", - "kind": 65536, + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter inventory items by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 552, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search terms to search inventory items' sku, title, and description." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 553, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Location IDs to filter inventory items by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 554, + "name": "sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "SKUs to filter inventory items by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 555, + "name": "origin_country", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Origin countries to filter inventory items by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 556, + "name": "mid_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "MID codes to filter inventory items by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 557, + "name": "material", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Materials to filter inventory items by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 558, + "name": "hs_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "String filters to apply to inventory items' " + }, + { + "kind": "code", + "text": "`hs_code`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 559, + "name": "weight", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number filters to apply to inventory items' " + }, + { + "kind": "code", + "text": "`weight`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "reference", + "target": 3935, + "name": "NumericalComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 560, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number filters to apply to inventory items' " + }, + { + "kind": "code", + "text": "`length`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "reference", + "target": 3935, + "name": "NumericalComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 561, + "name": "height", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number filters to apply to inventory items' " + }, + { + "kind": "code", + "text": "`height`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "reference", + "target": 3935, + "name": "NumericalComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 562, + "name": "width", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number filters to apply to inventory items' " + }, + { + "kind": "code", + "text": "`width`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "reference", + "target": 3935, + "name": "NumericalComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 563, + "name": "requires_shipping", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter inventory items by whether they require shipping." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 564, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).expand" + } + }, + { + "id": 565, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).fields" + } + }, + { + "id": 566, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).offset" + } + }, + { + "id": 567, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).limit" + } + }, + { + "id": 548, + "name": "constructor", + "variant": "declaration", + "kind": 512, "flags": {}, - "children": [ + "signatures": [ { - "id": 489, - "name": "inventory_item", - "variant": "declaration", - "kind": 1024, + "id": 549, + "name": "new AdminGetInventoryItemsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 550, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 547, + "name": "AdminGetInventoryItemsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 548 + ] + }, + { + "title": "Properties", + "children": [ + 551, + 552, + 553, + 554, + 555, + 556, + 557, + 558, + 559, + 560, + 561, + 562, + 563, + 564, + 565, + 566, + 567 + ] + } + ], + "extendedTypes": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ] + }, + { + "id": 568, + "name": "AdminGetInventoryItemsItemLocationLevelsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 569, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 570, + "name": "new AdminGetInventoryItemsItemLocationLevelsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 568, + "name": "AdminGetInventoryItemsItemLocationLevelsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 571, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Location IDs to filter location levels." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 572, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 573, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 569 + ] + }, + { + "title": "Properties", + "children": [ + 571, + 572, + 573 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 574, + "name": "AdminPostInventoryItemsInventoryItemReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attributes to update in an inventory item." + } + ] + }, + "children": [ + { + "id": 575, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 576, + "name": "new AdminPostInventoryItemsInventoryItemReq", + "variant": "signature", + "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "Inventory Item details" + "text": "The attributes to update in an inventory item." } ] }, "type": { "type": "reference", - "target": 4386, - "name": "InventoryItemDTO", - "package": "@medusajs/types" + "target": 574, + "name": "AdminPostInventoryItemsInventoryItemReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 577, + "name": "sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 578, + "name": "origin_country", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 579, + "name": "hs_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 580, + "name": "mid_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "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": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 581, + "name": "material", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "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": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 582, + "name": "weight", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The weight of the Inventory Item. May be used in shipping rate calculations." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 583, + "name": "height", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the Inventory Item. May be used in shipping rate calculations." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 584, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The length of the Inventory Item. May be used in shipping rate calculations." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 585, + "name": "width", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The width of the Inventory Item. May be used in shipping rate calculations." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 586, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's title." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 587, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's description." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 588, + "name": "thumbnail", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's thumbnail." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 589, + "name": "requires_shipping", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the item requires shipping." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 575 + ] + }, + { + "title": "Properties", + "children": [ + 577, + 578, + 579, + 580, + 581, + 582, + 583, + 584, + 585, + 586, + 587, + 588, + 589 + ] + } + ] + }, + { + "id": 590, + "name": "AdminPostInventoryItemsInventoryItemParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 591, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 592, + "name": "new AdminPostInventoryItemsInventoryItemParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 590, + "name": "AdminPostInventoryItemsInventoryItemParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" } } ], - "groups": [ - { - "title": "Properties", - "children": [ - 489 - ] - } + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 593, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 594, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 591 + ] + }, + { + "title": "Properties", + "children": [ + 593, + 594 ] } - } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 595, + "name": "AdminPostInventoryItemsItemLocationLevelsLevelReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 596, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 597, + "name": "new AdminPostInventoryItemsItemLocationLevelsLevelReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 595, + "name": "AdminPostInventoryItemsItemLocationLevelsLevelReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 598, + "name": "incoming_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the incoming stock quantity of an inventory item at the given location ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 599, + "name": "stocked_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the total stock quantity of an inventory item at the given location ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 596 + ] + }, + { + "title": "Properties", + "children": [ + 598, + 599 + ] + } + ] + }, + { + "id": 600, + "name": "AdminPostInventoryItemsItemLocationLevelsLevelParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 601, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 602, + "name": "new AdminPostInventoryItemsItemLocationLevelsLevelParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 600, + "name": "AdminPostInventoryItemsItemLocationLevelsLevelParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 603, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 604, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 601 + ] + }, + { + "title": "Properties", + "children": [ + 603, + 604 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 612, + "name": "AdminPostInvitesInviteAcceptUserReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Details of the use accepting the invite." + } + ] + }, + "children": [ + { + "id": 613, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 614, + "name": "new AdminPostInvitesInviteAcceptUserReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 612, + "name": "AdminPostInvitesInviteAcceptUserReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 615, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The invite's first name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 616, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The invite's last name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 617, + "name": "password", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The invite's password" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 613 + ] + }, + { + "title": "Properties", + "children": [ + 615, + 616, + 617 + ] + } + ] + }, + { + "id": 618, + "name": "AdminPostInvitesInviteAcceptReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the invite to be accepted." + } + ] + }, + "children": [ + { + "id": 619, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 620, + "name": "new AdminPostInvitesInviteAcceptReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the invite to be accepted." + } + ] + }, + "type": { + "type": "reference", + "target": 618, + "name": "AdminPostInvitesInviteAcceptReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 621, + "name": "token", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The token of the invite to accept. This is a unique token generated when the invite was created or resent." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 622, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the user to create." + } + ] + }, + "type": { + "type": "reference", + "target": 612, + "name": "AdminPostInvitesInviteAcceptUserReq", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 619 + ] + }, + { + "title": "Properties", + "children": [ + 621, + 622 + ] + } + ] + }, + { + "id": 623, + "name": "AdminPostInvitesReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 624, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 625, + "name": "new AdminPostInvitesReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 623, + "name": "AdminPostInvitesReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 626, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The email associated with the invite. Once the invite is accepted, the email will be associated with the created user." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 627, + "name": "role", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The role of the user to be created. This does not actually change the privileges of the user that is eventually created." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/user.ts", + "qualifiedName": "UserRoles" + }, + "name": "UserRoles", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 624 + ] + }, + { + "title": "Properties", + "children": [ + 626, + 627 + ] + } + ] + }, + { + "id": 605, + "name": "unauthenticatedInviteRoutes", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 606, + "name": "unauthenticatedInviteRoutes", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 607, + "name": "app", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] }, { "id": 608, @@ -91316,7 +17755,7 @@ }, "type": { "type": "reference", - "target": 3904, + "target": 3911, "name": "DeleteResponse", "package": "@medusajs/medusa" } @@ -91387,99 +17826,124 @@ } }, { - "id": 631, - "name": "AdminNotesDeleteRes", + "id": 635, + "name": "AdminPostNotesReq", "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 632, - "name": "AdminNotesListRes", - "variant": "declaration", - "kind": 2097152, + "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The list of notes with pagination fields." + "text": "The details of the note to be created." } - ], - "modifierTags": [ - "@interface" ] }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 633, - "name": "__type", - "variant": "declaration", - "kind": 65536, + "children": [ + { + "id": 636, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 637, + "name": "new AdminPostNotesReq", + "variant": "signature", + "kind": 16384, "flags": {}, - "children": [ - { - "id": 634, - "name": "notes", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of notes" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/note.ts", - "qualifiedName": "Note" - }, - "name": "Note", - "package": "@medusajs/medusa" - } + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the note to be created." } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 634 - ] - } - ] + ] + }, + "type": { + "type": "reference", + "target": 635, + "name": "AdminPostNotesReq", + "package": "@medusajs/medusa" + } } + ] + }, + { + "id": 638, + "name": "resource_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the resource which the Note relates to. For example, an order ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" } - ] - } + }, + { + "id": 639, + "name": "resource_type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of resource which the Note relates to. For example, `order`." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 640, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The content of the Note to create." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 636 + ] + }, + { + "title": "Properties", + "children": [ + 638, + 639, + 640 + ] + } + ] }, { "id": 628, @@ -91543,6 +18007,353 @@ } } }, + { + "id": 631, + "name": "AdminNotesDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 632, + "name": "AdminNotesListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of notes with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 633, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 634, + "name": "notes", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of notes" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/note.ts", + "qualifiedName": "Note" + }, + "name": "Note", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 634 + ] + } + ] + } + } + ] + } + }, + { + "id": 641, + "name": "AdminGetNotesParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved notes." + } + ] + }, + "children": [ + { + "id": 642, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 643, + "name": "new AdminGetNotesParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 641, + "name": "AdminGetNotesParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 644, + "name": "resource_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource ID to filter notes by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 645, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n50\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "50" + }, + { + "id": 646, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 642 + ] + }, + { + "title": "Properties", + "children": [ + 644, + 645, + 646 + ] + } + ] + }, + { + "id": 647, + "name": "AdminPostNotesNoteReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the note." + } + ] + }, + "children": [ + { + "id": 648, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 649, + "name": "new AdminPostNotesNoteReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the note." + } + ] + }, + "type": { + "type": "reference", + "target": 647, + "name": "AdminPostNotesNoteReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 650, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the Note." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 648 + ] + }, + { + "title": "Properties", + "children": [ + 650 + ] + } + ] + }, + { + "id": 651, + "name": "defaultAdminNotificationsRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 652, + "name": "defaultAdminNotificationsFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, { "id": 653, "name": "AdminNotificationsListRes", @@ -91560,7 +18371,7 @@ "types": [ { "type": "reference", - "target": 4418, + "target": 4425, "name": "PaginatedResponse", "package": "@medusajs/types" }, @@ -91677,198 +18488,745 @@ } }, { - "id": 681, - "name": "AdminOrderEditDeleteRes", + "id": 659, + "name": "AdminGetNotificationsParams", "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 682, - "name": "AdminOrderEditItemChangeDeleteRes", - "variant": "declaration", - "kind": 2097152, + "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The details of deleting order edit item changes." + "text": "Parameters used to filter and configure the pagination of the retrieved notifications." } - ], - "modifierTags": [ - "@interface" ] }, - "type": { - "type": "reflection", - "declaration": { - "id": 683, - "name": "__type", + "children": [ + { + "id": 660, + "name": "constructor", "variant": "declaration", - "kind": 65536, + "kind": 512, "flags": {}, - "children": [ + "signatures": [ { - "id": 686, - "name": "deleted", - "variant": "declaration", - "kind": 1024, + "id": 661, + "name": "new AdminGetNotificationsParams", + "variant": "signature", + "kind": 16384, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether or not the Order Edit Item Change was deleted." - } - ] - }, "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": true - }, - { - "id": 684, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the deleted Order Edit Item Change." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" + "type": "reference", + "target": 659, + "name": "AdminGetNotificationsParams", + "package": "@medusajs/medusa" } - }, - { - "id": 685, - "name": "object", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the object that was deleted." - } - ] - }, - "type": { - "type": "literal", - "value": "item_change" - }, - "defaultValue": "item_change" - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 686, - 684, - 685 - ] } ] + }, + { + "id": 662, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n50\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "50" + }, + { + "id": 663, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 664, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 665, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 666, + "name": "event_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Event name to filter notifications by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 667, + "name": "resource_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource type to filter notifications by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 668, + "name": "resource_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Resource ID to filter notifications by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 669, + "name": "to", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter notifications by their " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 670, + "name": "include_resends", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include resends in the results." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } } - } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 660 + ] + }, + { + "title": "Properties", + "children": [ + 662, + 663, + 664, + 665, + 666, + 667, + 668, + 669, + 670 + ] + } + ] }, { - "id": 678, - "name": "AdminOrderEditsListRes", + "id": 671, + "name": "AdminPostNotificationsNotificationResendReq", "variant": "declaration", - "kind": 2097152, + "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The list of order edits with pagination fields." + "text": "The resend details." } - ], - "modifierTags": [ - "@interface" ] }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 679, - "name": "__type", - "variant": "declaration", - "kind": 65536, + "children": [ + { + "id": 672, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 673, + "name": "new AdminPostNotificationsNotificationResendReq", + "variant": "signature", + "kind": 16384, "flags": {}, - "children": [ - { - "id": 680, - "name": "order_edits", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of order edit details" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order-edit.ts", - "qualifiedName": "OrderEdit" - }, - "name": "OrderEdit", - "package": "@medusajs/medusa" - } + "comment": { + "summary": [ + { + "kind": "text", + "text": "The resend details." } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 680 - ] - } - ] + ] + }, + "type": { + "type": "reference", + "target": 671, + "name": "AdminPostNotificationsNotificationResendReq", + "package": "@medusajs/medusa" + } } + ] + }, + { + "id": 674, + "name": "to", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A new address or user identifier that the Notification should be sent to. If not provided, the previous `to` field of the notification will be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 672 + ] + }, + { + "title": "Properties", + "children": [ + 674 + ] + } + ] + }, + { + "id": 687, + "name": "AdminPostOrderEditsEditLineItemsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the line item change to create." } ] - } + }, + "children": [ + { + "id": 688, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 689, + "name": "new AdminPostOrderEditsEditLineItemsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the line item change to create." + } + ] + }, + "type": { + "type": "reference", + "target": 687, + "name": "AdminPostOrderEditsEditLineItemsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 690, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product variant associated with the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 691, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 692, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 688 + ] + }, + { + "title": "Properties", + "children": [ + 690, + 691, + 692 + ] + } + ] + }, + { + "id": 693, + "name": "AdminPostOrderEditsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the order edit to create." + } + ] + }, + "children": [ + { + "id": 694, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 695, + "name": "new AdminPostOrderEditsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the order edit to create." + } + ] + }, + "type": { + "type": "reference", + "target": 693, + "name": "AdminPostOrderEditsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 696, + "name": "order_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the order to create the edit for." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 697, + "name": "internal_note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional note to associate with the order edit." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 698, + "name": "created_by", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 694 + ] + }, + { + "title": "Properties", + "children": [ + 696, + 697, + 698 + ] + } + ] + }, + { + "id": 699, + "name": "GetOrderEditsOrderEditParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 700, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 701, + "name": "new GetOrderEditsOrderEditParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 699, + "name": "GetOrderEditsOrderEditParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 702, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 703, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 700 + ] + }, + { + "title": "Properties", + "children": [ + 702, + 703 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] }, { "id": 675, @@ -91933,8 +19291,8 @@ } }, { - "id": 729, - "name": "AdminOrdersListRes", + "id": 678, + "name": "AdminOrderEditsListRes", "variant": "declaration", "kind": 2097152, "flags": {}, @@ -91942,7 +19300,7 @@ "summary": [ { "kind": "text", - "text": "The list of orders with pagination fields." + "text": "The list of order edits with pagination fields." } ], "modifierTags": [ @@ -91954,22 +19312,22 @@ "types": [ { "type": "reference", - "target": 3900, + "target": 3907, "name": "PaginatedResponse", "package": "@medusajs/medusa" }, { "type": "reflection", "declaration": { - "id": 730, + "id": 679, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 731, - "name": "orders", + "id": 680, + "name": "order_edits", "variant": "declaration", "kind": 1024, "flags": {}, @@ -91977,7 +19335,7 @@ "summary": [ { "kind": "text", - "text": "An array of order details." + "text": "An array of order edit details" } ] }, @@ -91986,10 +19344,10 @@ "elementType": { "type": "reference", "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "Order" + "sourceFileName": "../../../packages/medusa/src/models/order-edit.ts", + "qualifiedName": "OrderEdit" }, - "name": "Order", + "name": "OrderEdit", "package": "@medusajs/medusa" } } @@ -91999,7 +19357,7 @@ { "title": "Properties", "children": [ - 731 + 680 ] } ] @@ -92008,6 +19366,5680 @@ ] } }, + { + "id": 681, + "name": "AdminOrderEditDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 682, + "name": "AdminOrderEditItemChangeDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of deleting order edit item changes." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 683, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 684, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the deleted Order Edit Item Change." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 685, + "name": "object", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the object that was deleted." + } + ] + }, + "type": { + "type": "literal", + "value": "item_change" + }, + "defaultValue": "item_change" + }, + { + "id": 686, + "name": "deleted", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether or not the Order Edit Item Change was deleted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": true + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 684, + 685, + 686 + ] + } + ] + } + } + }, + { + "id": 704, + "name": "GetOrderEditsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved order edits." + } + ] + }, + "children": [ + { + "id": 708, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search order edits by their internal note." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 709, + "name": "order_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter the order edits by their associated order's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 710, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).expand" + } + }, + { + "id": 711, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).fields" + } + }, + { + "id": 712, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).offset" + } + }, + { + "id": 713, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).limit" + } + }, + { + "id": 705, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 706, + "name": "new GetOrderEditsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 707, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 704, + "name": "GetOrderEditsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 705 + ] + }, + { + "title": "Properties", + "children": [ + 708, + 709, + 710, + 711, + 712, + 713 + ] + } + ], + "extendedTypes": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ] + }, + { + "id": 714, + "name": "AdminPostOrderEditsRequestConfirmationReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 715, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 716, + "name": "new AdminPostOrderEditsRequestConfirmationReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 714, + "name": "AdminPostOrderEditsRequestConfirmationReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 717, + "name": "payment_collection_description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 715 + ] + }, + { + "title": "Properties", + "children": [ + 717 + ] + } + ] + }, + { + "id": 722, + "name": "AdminPostOrderEditsEditLineItemsLineItemReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to create or update of the line item change." + } + ] + }, + "children": [ + { + "id": 723, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 724, + "name": "new AdminPostOrderEditsEditLineItemsLineItemReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to create or update of the line item change." + } + ] + }, + "type": { + "type": "reference", + "target": 722, + "name": "AdminPostOrderEditsEditLineItemsLineItemReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 725, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity to update" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 723 + ] + }, + { + "title": "Properties", + "children": [ + 725 + ] + } + ] + }, + { + "id": 718, + "name": "AdminPostOrderEditsOrderEditReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the order edit." + } + ] + }, + "children": [ + { + "id": 719, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 720, + "name": "new AdminPostOrderEditsOrderEditReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the order edit." + } + ] + }, + "type": { + "type": "reference", + "target": 718, + "name": "AdminPostOrderEditsOrderEditReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 721, + "name": "internal_note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional note to create or update in the order edit." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 719 + ] + }, + { + "title": "Properties", + "children": [ + 721 + ] + } + ] + }, + { + "id": 737, + "name": "AdminPostOrdersOrderShippingMethodsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method's details." + } + ] + }, + "children": [ + { + "id": 738, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 739, + "name": "new AdminPostOrdersOrderShippingMethodsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method's details." + } + ] + }, + "type": { + "type": "reference", + "target": 737, + "name": "AdminPostOrdersOrderShippingMethodsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 740, + "name": "price", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price (excluding VAT) that should be charged for the Shipping Method" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 741, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Shipping Option to create the Shipping Method from." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 742, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data required for the Shipping Option to create a Shipping Method. This depends on the Fulfillment Provider." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "defaultValue": "{}" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 738 + ] + }, + { + "title": "Properties", + "children": [ + 740, + 741, + 742 + ] + } + ] + }, + { + "id": 743, + "name": "AdminPostOrdersOrderShippingMethodsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 744, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 745, + "name": "new AdminPostOrdersOrderShippingMethodsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 743, + "name": "AdminPostOrdersOrderShippingMethodsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 746, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 747, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 744 + ] + }, + { + "title": "Properties", + "children": [ + 746, + 747 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 748, + "name": "AdminPostOrdersOrderArchiveParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 749, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 750, + "name": "new AdminPostOrdersOrderArchiveParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 748, + "name": "AdminPostOrdersOrderArchiveParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 751, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 752, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 749 + ] + }, + { + "title": "Properties", + "children": [ + 751, + 752 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 753, + "name": "AdminPostOrdersClaimCancel", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 754, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 755, + "name": "new AdminPostOrdersClaimCancel", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 753, + "name": "AdminPostOrdersClaimCancel", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 756, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 757, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 754 + ] + }, + { + "title": "Properties", + "children": [ + 756, + 757 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 769, + "name": "AdminPostOrdersClaimFulfillmentsCancelParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 770, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 771, + "name": "new AdminPostOrdersClaimFulfillmentsCancelParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 769, + "name": "AdminPostOrdersClaimFulfillmentsCancelParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 772, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 773, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 770 + ] + }, + { + "title": "Properties", + "children": [ + 772, + 773 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 774, + "name": "AdminPostOrdersOrderSwapFulfillementsCancelParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 775, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 776, + "name": "new AdminPostOrdersOrderSwapFulfillementsCancelParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 774, + "name": "AdminPostOrdersOrderSwapFulfillementsCancelParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 777, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 778, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 775 + ] + }, + { + "title": "Properties", + "children": [ + 777, + 778 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 758, + "name": "adjustInventoryForCancelledFulfillment", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 759, + "name": "adjustInventoryForCancelledFulfillment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 760, + "name": "fulfillment", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/fulfillment.ts", + "qualifiedName": "Fulfillment" + }, + "name": "Fulfillment", + "package": "@medusajs/medusa" + } + }, + { + "id": 761, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 762, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 763, + "name": "productVariantInventoryService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", + "qualifiedName": "ProductVariantInventoryService" + }, + "name": "ProductVariantInventoryService", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 763 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 764, + "name": "AdminPostOrdersOrderFulfillementsCancelParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 765, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 766, + "name": "new AdminPostOrdersOrderFulfillementsCancelParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 764, + "name": "AdminPostOrdersOrderFulfillementsCancelParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 767, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 768, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 765 + ] + }, + { + "title": "Properties", + "children": [ + 767, + 768 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 779, + "name": "AdminPostOrdersOrderCancel", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 780, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 781, + "name": "new AdminPostOrdersOrderCancel", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 779, + "name": "AdminPostOrdersOrderCancel", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 782, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 783, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 780 + ] + }, + { + "title": "Properties", + "children": [ + 782, + 783 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 784, + "name": "AdminPostOrdersSwapCancelParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 785, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 786, + "name": "new AdminPostOrdersSwapCancelParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 784, + "name": "AdminPostOrdersSwapCancelParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 787, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 788, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 785 + ] + }, + { + "title": "Properties", + "children": [ + 787, + 788 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 789, + "name": "AdminPostOrdersOrderCaptureParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 790, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 791, + "name": "new AdminPostOrdersOrderCaptureParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 789, + "name": "AdminPostOrdersOrderCaptureParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 792, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 793, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 790 + ] + }, + { + "title": "Properties", + "children": [ + 792, + 793 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 794, + "name": "AdminPostOrdersOrderCompleteParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 795, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 796, + "name": "new AdminPostOrdersOrderCompleteParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 794, + "name": "AdminPostOrdersOrderCompleteParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 797, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 798, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 795 + ] + }, + { + "title": "Properties", + "children": [ + 797, + 798 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 817, + "name": "AdminPostOrdersOrderClaimsClaimShipmentsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 818, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 819, + "name": "new AdminPostOrdersOrderClaimsClaimShipmentsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 817, + "name": "AdminPostOrdersOrderClaimsClaimShipmentsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 820, + "name": "fulfillment_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Fulfillment." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 821, + "name": "tracking_numbers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of tracking numbers for the shipment." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 818 + ] + }, + { + "title": "Properties", + "children": [ + 820, + 821 + ] + } + ] + }, + { + "id": 822, + "name": "AdminPostOrdersOrderClaimsClaimShipmentsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 823, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 824, + "name": "new AdminPostOrdersOrderClaimsClaimShipmentsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 822, + "name": "AdminPostOrdersOrderClaimsClaimShipmentsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 825, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 826, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 823 + ] + }, + { + "title": "Properties", + "children": [ + 825, + 826 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 799, + "name": "AdminPostOrdersOrderClaimsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the claim to be created." + } + ] + }, + "children": [ + { + "id": 800, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 801, + "name": "new AdminPostOrdersOrderClaimsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the claim to be created." + } + ] + }, + "type": { + "type": "reference", + "target": 799, + "name": "AdminPostOrdersOrderClaimsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 802, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the Claim. This will determine how the Claim is treated: `replace` Claims will result in a Fulfillment with new items being created, while a `refund` Claim will refund the amount paid for the claimed items." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "replace" + }, + { + "type": "literal", + "value": "refund" + } + ] + } + }, + { + "id": 803, + "name": "claim_items", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Claim Items that the Claim will consist of." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4430, + "name": "Item", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 804, + "name": "return_shipping", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Optional details for the Return Shipping Method, if the items are to be sent back. Providing this field will result in a return being created and associated with the claim." + } + ] + }, + "type": { + "type": "reference", + "target": 4439, + "name": "ReturnShipping", + "package": "@medusajs/medusa" + } + }, + { + "id": 805, + "name": "additional_items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new items to send to the Customer. This is only used if the claim's type is `replace`." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4444, + "name": "AdditionalItem", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 806, + "name": "shipping_methods", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Shipping Methods to send the additional Line Items with. This is only used if the claim's type is `replace`." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4449, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 807, + "name": "refund_amount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount to refund the customer. This is used when the claim's type is `refund`." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 808, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional shipping address to send the claimed items to. If not provided, the parent order's shipping address will be used." + } + ] + }, + "type": { + "type": "reference", + "target": 3942, + "name": "AddressPayload", + "package": "@medusajs/medusa" + } + }, + { + "id": 809, + "name": "no_notification", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to true no notification will be send related to this Claim." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 810, + "name": "return_location_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the location used for the associated return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 811, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 800 + ] + }, + { + "title": "Properties", + "children": [ + 802, + 803, + 804, + 805, + 806, + 807, + 808, + 809, + 810, + 811 + ] + } + ] + }, + { + "id": 4439, + "name": "ReturnShipping", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return's shipping method details." + } + ] + }, + "children": [ + { + "id": 4440, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4441, + "name": "new ReturnShipping", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4439, + "name": "ReturnShipping", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4442, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the shipping option used for the return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4443, + "name": "price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method's price." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4440 + ] + }, + { + "title": "Properties", + "children": [ + 4442, + 4443 + ] + } + ] + }, + { + "id": 4449, + "name": "ShippingMethod", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." + } + ] + }, + "children": [ + { + "id": 4450, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4451, + "name": "new ShippingMethod", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." + } + ] + }, + "type": { + "type": "reference", + "target": 4449, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4452, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of an existing Shipping Method" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4453, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Shipping Option to create a Shipping Method from" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4454, + "name": "price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price to charge for the Shipping Method" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4455, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4450 + ] + }, + { + "title": "Properties", + "children": [ + 4452, + 4453, + 4454, + 4455 + ] + } + ] + }, + { + "id": 4430, + "name": "Item", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4431, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4432, + "name": "new Item", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4430, + "name": "Item", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4433, + "name": "item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Line Item that will be claimed." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4434, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items that will be returned" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4435, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Short text describing the Claim Item in further detail." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4436, + "name": "reason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reason for the Claim" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/claim-item.ts", + "qualifiedName": "ClaimReason" + }, + "name": "ClaimReason", + "package": "@medusajs/medusa" + } + }, + { + "id": 4437, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of tags to add to the Claim Item" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4438, + "name": "images", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of image URL's that will be associated with the Claim" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4431 + ] + }, + { + "title": "Properties", + "children": [ + 4433, + 4434, + 4435, + 4436, + 4437, + 4438 + ] + } + ] + }, + { + "id": 4444, + "name": "AdditionalItem", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4445, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4446, + "name": "new AdditionalItem", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4444, + "name": "AdditionalItem", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4447, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4448, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4445 + ] + }, + { + "title": "Properties", + "children": [ + 4447, + 4448 + ] + } + ] + }, + { + "id": 812, + "name": "AdminPostOrdersOrderClaimsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 813, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 814, + "name": "new AdminPostOrdersOrderClaimsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 812, + "name": "AdminPostOrdersOrderClaimsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 815, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 816, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 813 + ] + }, + { + "title": "Properties", + "children": [ + 815, + 816 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 827, + "name": "updateInventoryAndReservations", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 828, + "name": "updateInventoryAndReservations", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 829, + "name": "fulfillments", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/fulfillment.ts", + "qualifiedName": "Fulfillment" + }, + "name": "Fulfillment", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 830, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 831, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 832, + "name": "inventoryService", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", + "qualifiedName": "ProductVariantInventoryService" + }, + "name": "ProductVariantInventoryService", + "package": "@medusajs/medusa" + } + }, + { + "id": 833, + "name": "locationId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 832, + 833 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 834, + "name": "AdminPostOrdersOrderFulfillmentsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the fulfillment to be created." + } + ] + }, + "children": [ + { + "id": 835, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 836, + "name": "new AdminPostOrdersOrderFulfillmentsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the fulfillment to be created." + } + ] + }, + "type": { + "type": "reference", + "target": 834, + "name": "AdminPostOrdersOrderFulfillmentsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 837, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Line Items to include in the Fulfillment." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4456, + "name": "Item", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 838, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the location where the items will be fulfilled from." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 839, + "name": "no_notification", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, no notification will be sent to the customer related to this fulfillment." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 840, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 835 + ] + }, + { + "title": "Properties", + "children": [ + 837, + 838, + 839, + 840 + ] + } + ] + }, + { + "id": 4456, + "name": "Item", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4457, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4458, + "name": "new Item", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4456, + "name": "Item", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4459, + "name": "item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Line Item to fulfill." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4460, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the Line Item to fulfill." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4457 + ] + }, + { + "title": "Properties", + "children": [ + 4459, + 4460 + ] + } + ] + }, + { + "id": 841, + "name": "AdminPostOrdersOrderFulfillmentsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 842, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 843, + "name": "new AdminPostOrdersOrderFulfillmentsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 841, + "name": "AdminPostOrdersOrderFulfillmentsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 844, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 845, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 842 + ] + }, + { + "title": "Properties", + "children": [ + 844, + 845 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 846, + "name": "AdminPostOrdersOrderShipmentReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipment to create." + } + ] + }, + "children": [ + { + "id": 847, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 848, + "name": "new AdminPostOrdersOrderShipmentReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipment to create." + } + ] + }, + "type": { + "type": "reference", + "target": 846, + "name": "AdminPostOrdersOrderShipmentReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 849, + "name": "fulfillment_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Fulfillment." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 850, + "name": "tracking_numbers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tracking numbers for the shipment." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 851, + "name": "no_notification", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to true no notification will be send related to this Shipment." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 847 + ] + }, + { + "title": "Properties", + "children": [ + 849, + 850, + 851 + ] + } + ] + }, + { + "id": 852, + "name": "AdminPostOrdersOrderShipmentParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 853, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 854, + "name": "new AdminPostOrdersOrderShipmentParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 852, + "name": "AdminPostOrdersOrderShipmentParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 855, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 856, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 853 + ] + }, + { + "title": "Properties", + "children": [ + 855, + 856 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 873, + "name": "AdminPostOrdersOrderSwapsSwapShipmentsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 874, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 875, + "name": "new AdminPostOrdersOrderSwapsSwapShipmentsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 873, + "name": "AdminPostOrdersOrderSwapsSwapShipmentsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 876, + "name": "fulfillment_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Fulfillment." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 877, + "name": "tracking_numbers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tracking numbers for the shipment." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "[]" + }, + { + "id": 878, + "name": "no_notification", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to true no notification will be sent related to this Claim." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 874 + ] + }, + { + "title": "Properties", + "children": [ + 876, + 877, + 878 + ] + } + ] + }, + { + "id": 879, + "name": "AdminPostOrdersOrderSwapsSwapShipmentsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 880, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 881, + "name": "new AdminPostOrdersOrderSwapsSwapShipmentsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 879, + "name": "AdminPostOrdersOrderSwapsSwapShipmentsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 882, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 883, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 880 + ] + }, + { + "title": "Properties", + "children": [ + 882, + 883 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 857, + "name": "AdminPostOrdersOrderSwapsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the swap to create." + } + ] + }, + "children": [ + { + "id": 858, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 859, + "name": "new AdminPostOrdersOrderSwapsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the swap to create." + } + ] + }, + "type": { + "type": "reference", + "target": 857, + "name": "AdminPostOrdersOrderSwapsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 860, + "name": "return_items", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Line Items to associate with the swap's return." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4461, + "name": "ReturnItem", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 861, + "name": "return_shipping", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method associated with the swap's return." + } + ] + }, + "type": { + "type": "reference", + "target": 4468, + "name": "ReturnShipping", + "package": "@medusajs/medusa" + } + }, + { + "id": 862, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the sales channel associated with the swap." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 863, + "name": "additional_items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new items to send to the Customer." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4473, + "name": "AdditionalItem", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 864, + "name": "custom_shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of custom shipping options to potentially create a Shipping Method from to send the additional items." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4478, + "name": "CustomShippingOption", + "package": "@medusajs/medusa" + } + }, + "defaultValue": "[]" + }, + { + "id": 865, + "name": "no_notification", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, no notification will be sent to the customer related to this Swap." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 866, + "name": "return_location_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the location used for the associated return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 867, + "name": "allow_backorder", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, swaps can be completed with items out of stock" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "true" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 858 + ] + }, + { + "title": "Properties", + "children": [ + 860, + 861, + 862, + 863, + 864, + 865, + 866, + 867 + ] + } + ] + }, + { + "id": 4461, + "name": "ReturnItem", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A return item represents a line item in an order that is to be returned. It includes details related to the return and the reason behind it." + } + ] + }, + "children": [ + { + "id": 4462, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4463, + "name": "new ReturnItem", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A return item represents a line item in an order that is to be returned. It includes details related to the return and the reason behind it." + } + ] + }, + "type": { + "type": "reference", + "target": 4461, + "name": "ReturnItem", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4464, + "name": "item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Line Item that will be returned." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4465, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items that will be returned" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4466, + "name": "reason_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Return Reason to use." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4467, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional note with information about the Return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4462 + ] + }, + { + "title": "Properties", + "children": [ + 4464, + 4465, + 4466, + 4467 + ] + } + ] + }, + { + "id": 4468, + "name": "ReturnShipping", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return's shipping method details." + } + ] + }, + "children": [ + { + "id": 4469, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4470, + "name": "new ReturnShipping", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4468, + "name": "ReturnShipping", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4471, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the shipping option used for the return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4472, + "name": "price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method's price." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4469 + ] + }, + { + "title": "Properties", + "children": [ + 4471, + 4472 + ] + } + ] + }, + { + "id": 4478, + "name": "CustomShippingOption", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Custom Shipping Options are overridden Shipping Options. Admins can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option." + } + ] + }, + "children": [ + { + "id": 4479, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4480, + "name": "new CustomShippingOption", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Custom Shipping Options are overridden Shipping Options. Admins can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option." + } + ] + }, + "type": { + "type": "reference", + "target": 4478, + "name": "CustomShippingOption", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4481, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Shipping Option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4482, + "name": "price", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The custom price of the Shipping Option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4479 + ] + }, + { + "title": "Properties", + "children": [ + 4481, + 4482 + ] + } + ] + }, + { + "id": 4473, + "name": "AdditionalItem", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4474, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4475, + "name": "new AdditionalItem", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4473, + "name": "AdditionalItem", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4476, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4477, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4474 + ] + }, + { + "title": "Properties", + "children": [ + 4476, + 4477 + ] + } + ] + }, + { + "id": 868, + "name": "AdminPostOrdersOrderSwapsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 869, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 870, + "name": "new AdminPostOrdersOrderSwapsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 868, + "name": "AdminPostOrdersOrderSwapsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 871, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 872, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 869 + ] + }, + { + "title": "Properties", + "children": [ + 871, + 872 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 884, + "name": "AdminPostOrdersOrderClaimsClaimFulfillmentsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 885, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 886, + "name": "new AdminPostOrdersOrderClaimsClaimFulfillmentsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 884, + "name": "AdminPostOrdersOrderClaimsClaimFulfillmentsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 887, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 888, + "name": "no_notification", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, no notification will be sent to the customer related to this Claim." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 889, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the fulfillment's location." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 885 + ] + }, + { + "title": "Properties", + "children": [ + 887, + 888, + 889 + ] + } + ] + }, + { + "id": 890, + "name": "AdminPostOrdersOrderClaimsClaimFulfillmentsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 891, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 892, + "name": "new AdminPostOrdersOrderClaimsClaimFulfillmentsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 890, + "name": "AdminPostOrdersOrderClaimsClaimFulfillmentsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 893, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 894, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 891 + ] + }, + { + "title": "Properties", + "children": [ + 893, + 894 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 895, + "name": "AdminPostOrdersOrderSwapsSwapFulfillmentsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 896, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 897, + "name": "new AdminPostOrdersOrderSwapsSwapFulfillmentsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 895, + "name": "AdminPostOrdersOrderSwapsSwapFulfillmentsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 898, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 899, + "name": "no_notification", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, no notification will be sent to the customer related to this swap." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 900, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the fulfillment's location." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 896 + ] + }, + { + "title": "Properties", + "children": [ + 898, + 899, + 900 + ] + } + ] + }, + { + "id": 901, + "name": "AdminPostOrdersOrderSwapsSwapFulfillmentsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 902, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 903, + "name": "new AdminPostOrdersOrderSwapsSwapFulfillmentsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 901, + "name": "AdminPostOrdersOrderSwapsSwapFulfillmentsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 904, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 905, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 902 + ] + }, + { + "title": "Properties", + "children": [ + 904, + 905 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 906, + "name": "AdminGetOrdersOrderParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 907, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 908, + "name": "new AdminGetOrdersOrderParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 906, + "name": "AdminGetOrdersOrderParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 909, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 910, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 907 + ] + }, + { + "title": "Properties", + "children": [ + 909, + 910 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, { "id": 726, "name": "AdminOrdersRes", @@ -92071,8 +25103,8 @@ } }, { - "id": 1001, - "name": "AdminPaymentCollectionDeleteRes", + "id": 729, + "name": "AdminOrdersListRes", "variant": "declaration", "kind": 2097152, "flags": {}, @@ -92080,94 +25112,3397 @@ "summary": [ { "kind": "text", - "text": "The details of deleting a payment collection." + "text": "The list of orders with pagination fields." } ], "modifierTags": [ "@interface" ] }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 730, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 731, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of order details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 731 + ] + } + ] + } + } + ] + } + }, + { + "id": 732, + "name": "filterableAdminOrdersFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 733, + "name": "AvailableOrderIncludes", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, "type": { "type": "reflection", "declaration": { - "id": 1002, + "id": 734, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1005, - "name": "deleted", + "id": 735, + "name": "RETURNABLE_ITEMS", "variant": "declaration", "kind": 1024, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether or not the Payment Collection was deleted." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": true - }, - { - "id": 1003, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the deleted Payment Collection." - } - ] - }, "type": { "type": "intrinsic", "name": "string" - } - }, - { - "id": 1004, - "name": "object", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the object that was deleted." - } - ] }, - "type": { - "type": "literal", - "value": "payment_collection" - }, - "defaultValue": "payment_collection" + "defaultValue": "\"returnable_items\"" } ], "groups": [ { "title": "Properties", "children": [ - 1005, - 1003, - 1004 + 735 ] } ] } - } + }, + "defaultValue": "..." + }, + { + "id": 736, + "name": "allowedOrderIncludes", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 911, + "name": "AdminGetOrdersParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved orders." + } + ] + }, + "children": [ + { + "id": 912, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 913, + "name": "new AdminGetOrdersParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 911, + "name": "AdminGetOrdersParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4485, + "name": "AdminListOrdersSelector.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4484, + "name": "AdminListOrdersSelector.constructor" + } + }, + { + "id": 914, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 915, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n50\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "50" + }, + { + "id": 916, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 917, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 918, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search orders' shipping address, first name, email, and display ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4486, + "name": "AdminListOrdersSelector.q" + } + }, + { + "id": 919, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4487, + "name": "AdminListOrdersSelector.id" + } + }, + { + "id": 920, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statuses to filter orders by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4488, + "name": "AdminListOrdersSelector.status" + } + }, + { + "id": 921, + "name": "fulfillment_status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fulfillment statuses to filter orders by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4489, + "name": "AdminListOrdersSelector.fulfillment_status" + } + }, + { + "id": 922, + "name": "payment_status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Payment statuses to filter orders by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4490, + "name": "AdminListOrdersSelector.payment_status" + } + }, + { + "id": 923, + "name": "display_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Display ID to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4491, + "name": "AdminListOrdersSelector.display_id" + } + }, + { + "id": 924, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cart ID to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4492, + "name": "AdminListOrdersSelector.cart_id" + } + }, + { + "id": 925, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Customer ID to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4493, + "name": "AdminListOrdersSelector.customer_id" + } + }, + { + "id": 926, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Email to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4494, + "name": "AdminListOrdersSelector.email" + } + }, + { + "id": 927, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Regions to filter orders by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 4495, + "name": "AdminListOrdersSelector.region_id" + } + }, + { + "id": 928, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Currency code to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4496, + "name": "AdminListOrdersSelector.currency_code" + } + }, + { + "id": 929, + "name": "tax_rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tax rate to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4497, + "name": "AdminListOrdersSelector.tax_rate" + } + }, + { + "id": 930, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sales channel IDs to filter orders by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4498, + "name": "AdminListOrdersSelector.sales_channel_id" + } + }, + { + "id": 931, + "name": "canceled_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the orders' " + }, + { + "kind": "code", + "text": "`canceled_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4499, + "name": "AdminListOrdersSelector.canceled_at" + } + }, + { + "id": 932, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the orders' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4500, + "name": "AdminListOrdersSelector.created_at" + } + }, + { + "id": 933, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the orders' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4501, + "name": "AdminListOrdersSelector.updated_at" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 912 + ] + }, + { + "title": "Properties", + "children": [ + 914, + 915, + 916, + 917, + 918, + 919, + 920, + 921, + 922, + 923, + 924, + 925, + 926, + 927, + 928, + 929, + 930, + 931, + 932, + 933 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4483, + "name": "AdminListOrdersSelector", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 934, + "name": "AdminPostOrdersOrderSwapsSwapProcessPaymentParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 935, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 936, + "name": "new AdminPostOrdersOrderSwapsSwapProcessPaymentParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 934, + "name": "AdminPostOrdersOrderSwapsSwapProcessPaymentParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 937, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 938, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 935 + ] + }, + { + "title": "Properties", + "children": [ + 937, + 938 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 939, + "name": "AdminPostOrdersOrderRefundsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the order refund." + } + ] + }, + "children": [ + { + "id": 940, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 941, + "name": "new AdminPostOrdersOrderRefundsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the order refund." + } + ] + }, + "type": { + "type": "reference", + "target": 939, + "name": "AdminPostOrdersOrderRefundsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 942, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount to refund. It should be less than or equal the `refundable_amount` of the order." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 943, + "name": "reason", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reason for the Refund." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 944, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A note with additional details about the Refund." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 945, + "name": "no_notification", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, no notification will be sent to the customer related to this Refund." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 940 + ] + }, + { + "title": "Properties", + "children": [ + 942, + 943, + 944, + 945 + ] + } + ] + }, + { + "id": 946, + "name": "AdminPostOrdersOrderRefundsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 947, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 948, + "name": "new AdminPostOrdersOrderRefundsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 946, + "name": "AdminPostOrdersOrderRefundsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 949, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 950, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 947 + ] + }, + { + "title": "Properties", + "children": [ + 949, + 950 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 951, + "name": "AdminPostOrdersOrderReturnsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the requested return." + } + ] + }, + "children": [ + { + "id": 952, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 953, + "name": "new AdminPostOrdersOrderReturnsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the requested return." + } + ] + }, + "type": { + "type": "reference", + "target": 951, + "name": "AdminPostOrdersOrderReturnsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 954, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line items that will be returned." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4502, + "name": "OrdersReturnItem", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 955, + "name": "return_shipping", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Shipping Method to be used to handle the return shipment." + } + ] + }, + "type": { + "type": "reference", + "target": 4509, + "name": "ReturnShipping", + "package": "@medusajs/medusa" + } + }, + { + "id": 956, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional note with information about the Return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 957, + "name": "receive_now", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A flag to indicate if the Return should be registerd as received immediately." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 958, + "name": "no_notification", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, no notification will be sent to the customer related to this Return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 959, + "name": "refund", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount to refund." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 960, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the location used for the return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 952 + ] + }, + { + "title": "Properties", + "children": [ + 954, + 955, + 956, + 957, + 958, + 959, + 960 + ] + } + ] + }, + { + "id": 4509, + "name": "ReturnShipping", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return's shipping method details." + } + ] + }, + "children": [ + { + "id": 4510, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4511, + "name": "new ReturnShipping", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4509, + "name": "ReturnShipping", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4512, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the shipping option used for the return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4513, + "name": "price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method's price." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4510 + ] + }, + { + "title": "Properties", + "children": [ + 4512, + 4513 + ] + } + ] + }, + { + "id": 961, + "name": "AdminPostOrdersOrderReturnsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 962, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 963, + "name": "new AdminPostOrdersOrderReturnsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 961, + "name": "AdminPostOrdersOrderReturnsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 964, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 965, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 962 + ] + }, + { + "title": "Properties", + "children": [ + 964, + 965 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 966, + "name": "AdminPostOrdersOrderClaimsClaimReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 967, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 968, + "name": "new AdminPostOrdersOrderClaimsClaimReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 966, + "name": "AdminPostOrdersOrderClaimsClaimReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 969, + "name": "claim_items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Claim Items that the Claim will consist of." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4514, + "name": "Item", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 970, + "name": "shipping_methods", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Shipping Methods to send the additional Line Items with." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4523, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 971, + "name": "no_notification", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to true no notification will be send related to this Swap." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 972, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 967 + ] + }, + { + "title": "Properties", + "children": [ + 969, + 970, + 971, + 972 + ] + } + ] + }, + { + "id": 4523, + "name": "ShippingMethod", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." + } + ] + }, + "children": [ + { + "id": 4524, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4525, + "name": "new ShippingMethod", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." + } + ] + }, + "type": { + "type": "reference", + "target": 4523, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4526, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of an existing Shipping Method" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4527, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Shipping Option to create a Shipping Method from" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4528, + "name": "price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price to charge for the Shipping Method" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4529, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4524 + ] + }, + { + "title": "Properties", + "children": [ + 4526, + 4527, + 4528, + 4529 + ] + } + ] + }, + { + "id": 4514, + "name": "Item", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4515, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4516, + "name": "new Item", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4514, + "name": "Item", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4517, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Claim Item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4518, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Short text describing the Claim Item in further detail." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4519, + "name": "reason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reason for the Claim" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4520, + "name": "images", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of image URL's that will be associated with the Claim" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4995, + "name": "Image", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 4521, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list o tags to add to the Claim Item" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5000, + "name": "Tag", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 4522, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4515 + ] + }, + { + "title": "Properties", + "children": [ + 4517, + 4518, + 4519, + 4520, + 4521, + 4522 + ] + } + ] + }, + { + "id": 4995, + "name": "Image", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An Image is used to store details about uploaded images. Images are uploaded by the File Service, and the URL is provided by the File Service." + } + ] + }, + "children": [ + { + "id": 4996, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4997, + "name": "new Image", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An Image is used to store details about uploaded images. Images are uploaded by the File Service, and the URL is provided by the File Service." + } + ] + }, + "type": { + "type": "reference", + "target": 4995, + "name": "Image", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4998, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Image ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4999, + "name": "url", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Image URL" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4996 + ] + }, + { + "title": "Properties", + "children": [ + 4998, + 4999 + ] + } + ] + }, + { + "id": 5000, + "name": "Tag", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 5001, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 5002, + "name": "new Tag", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 5000, + "name": "Tag", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 5003, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tag ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5004, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tag value" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 5001 + ] + }, + { + "title": "Properties", + "children": [ + 5003, + 5004 + ] + } + ] + }, + { + "id": 973, + "name": "AdminPostOrdersOrderClaimsClaimParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 974, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 975, + "name": "new AdminPostOrdersOrderClaimsClaimParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 973, + "name": "AdminPostOrdersOrderClaimsClaimParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 976, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 977, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 974 + ] + }, + { + "title": "Properties", + "children": [ + 976, + 977 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 978, + "name": "AdminPostOrdersOrderReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the order." + } + ] + }, + "children": [ + { + "id": 979, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 980, + "name": "new AdminPostOrdersOrderReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the order." + } + ] + }, + "type": { + "type": "reference", + "target": 978, + "name": "AdminPostOrdersOrderReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 981, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The email associated with the order" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 982, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's billing address" + } + ] + }, + "type": { + "type": "reference", + "target": 3942, + "name": "AddressPayload", + "package": "@medusajs/medusa" + } + }, + { + "id": 983, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's shipping address" + } + ] + }, + "type": { + "type": "reference", + "target": 3942, + "name": "AddressPayload", + "package": "@medusajs/medusa" + } + }, + { + "id": 984, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line items of the order" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + }, + { + "id": 985, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the region that the order is associated with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 986, + "name": "discounts", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discounts applied to the order" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + }, + { + "id": 987, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the customer associated with the order." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 988, + "name": "payment_method", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment method chosen for the order." + } + ] + }, + "type": { + "type": "reference", + "target": 4530, + "name": "PaymentMethod", + "package": "@medusajs/medusa" + } + }, + { + "id": 989, + "name": "shipping_method", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Shipping Method used for shipping the order." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4535, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 990, + "name": "no_notification", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, no notification will be sent to the customer related to this order." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 979 + ] + }, + { + "title": "Properties", + "children": [ + 981, + 982, + 983, + 984, + 985, + 986, + 987, + 988, + 989, + 990 + ] + } + ] + }, + { + "id": 4530, + "name": "PaymentMethod", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attributes to update in the order's payment method." + } + ] + }, + "children": [ + { + "id": 4531, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4532, + "name": "new PaymentMethod", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4530, + "name": "PaymentMethod", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4533, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the payment provider used in the order." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4534, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to attach to the payment." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4531 + ] + }, + { + "title": "Properties", + "children": [ + 4533, + 4534 + ] + } + ] + }, + { + "id": 4535, + "name": "ShippingMethod", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attributes to update in the order's shipping method." + } + ] + }, + "children": [ + { + "id": 4536, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4537, + "name": "new ShippingMethod", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." + } + ] + }, + "type": { + "type": "reference", + "target": 4535, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4538, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the shipping provider used in the order." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4539, + "name": "profile_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the shipping profile used in the order." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4540, + "name": "price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price of the shipping method." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4541, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to attach to the shipping method." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 4542, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line items associated with this shipping methods." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4536 + ] + }, + { + "title": "Properties", + "children": [ + 4538, + 4539, + 4540, + 4541, + 4542 + ] + } + ] + }, + { + "id": 991, + "name": "AdminPostOrdersOrderParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to configure the retrieved order." + } + ] + }, + "children": [ + { + "id": 992, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 993, + "name": "new AdminPostOrdersOrderParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 991, + "name": "AdminPostOrdersOrderParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 994, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 995, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 992 + ] + }, + { + "title": "Properties", + "children": [ + 994, + 995 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1006, + "name": "AdminGetPaymentCollectionsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1007, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1008, + "name": "new AdminGetPaymentCollectionsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1006, + "name": "AdminGetPaymentCollectionsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 1009, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 1010, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1007 + ] + }, + { + "title": "Properties", + "children": [ + 1009, + 1010 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 996, + "name": "defaultPaymentCollectionFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 997, + "name": "defaulPaymentCollectionRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." }, { "id": 998, @@ -92232,8 +28567,8 @@ } }, { - "id": 1870, - "name": "AdminPaymentProvidersList", + "id": 1001, + "name": "AdminPaymentCollectionDeleteRes", "variant": "declaration", "kind": 2097152, "flags": {}, @@ -92241,7 +28576,7 @@ "summary": [ { "kind": "text", - "text": "The list of payment providers in a store." + "text": "The details of deleting a payment collection." } ], "modifierTags": [ @@ -92251,15 +28586,15 @@ "type": { "type": "reflection", "declaration": { - "id": 1871, + "id": 1002, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1872, - "name": "payment_providers", + "id": 1003, + "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, @@ -92267,35 +28602,329 @@ "summary": [ { "kind": "text", - "text": "An array of payment providers details." + "text": "The ID of the deleted Payment Collection." } ] }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-provider.ts", - "qualifiedName": "PaymentProvider" - }, - "name": "PaymentProvider", - "package": "@medusajs/medusa" - } + "type": "intrinsic", + "name": "string" } + }, + { + "id": 1004, + "name": "object", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the object that was deleted." + } + ] + }, + "type": { + "type": "literal", + "value": "payment_collection" + }, + "defaultValue": "payment_collection" + }, + { + "id": 1005, + "name": "deleted", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether or not the Payment Collection was deleted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": true } ], "groups": [ { "title": "Properties", "children": [ - 1872 + 1003, + 1004, + 1005 ] } ] } } }, + { + "id": 1011, + "name": "AdminUpdatePaymentCollectionsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the payment collection." + } + ] + }, + "children": [ + { + "id": 1012, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1013, + "name": "new AdminUpdatePaymentCollectionsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the payment collection." + } + ] + }, + "type": { + "type": "reference", + "target": 1011, + "name": "AdminUpdatePaymentCollectionsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1014, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A description to create or update the payment collection." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1015, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1012 + ] + }, + { + "title": "Properties", + "children": [ + 1014, + 1015 + ] + } + ] + }, + { + "id": 1023, + "name": "GetPaymentsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1024, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1025, + "name": "new GetPaymentsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1023, + "name": "GetPaymentsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 1026, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 1027, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1024 + ] + }, + { + "title": "Properties", + "children": [ + 1026, + 1027 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1016, + "name": "defaultPaymentFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, { "id": 1017, "name": "AdminPaymentRes", @@ -92358,1732 +28987,6 @@ } } }, - { - "id": 390, - "name": "AdminPostDraftOrdersDraftOrderRegisterPaymentRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The order's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 391, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 392, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Order's details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "Order" - }, - "name": "Order", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 392 - ] - } - ] - } - } - }, - { - "id": 1068, - "name": "AdminPriceListDeleteBatchRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of deleting a price list." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1069, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1071, - "name": "deleted", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether or not the items were deleted." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": true - }, - { - "id": 1070, - "name": "ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs of the deleted prices." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1072, - "name": "object", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the object that was deleted. A price is also named `money-amount`." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "money-amount" - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1071, - 1070, - 1072 - ] - } - ] - } - } - }, - { - "id": 1073, - "name": "AdminPriceListDeleteProductPricesRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 1068, - "name": "AdminPriceListDeleteBatchRes", - "package": "@medusajs/medusa" - } - }, - { - "id": 1075, - "name": "AdminPriceListDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 1074, - "name": "AdminPriceListDeleteVariantPricesRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 1068, - "name": "AdminPriceListDeleteBatchRes", - "package": "@medusajs/medusa" - } - }, - { - "id": 1065, - "name": "AdminPriceListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1066, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1067, - "name": "price_list", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Price List details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/price-list.ts", - "qualifiedName": "PriceList" - }, - "name": "PriceList", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1067 - ] - } - ] - } - } - }, - { - "id": 1076, - "name": "AdminPriceListsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of price lists with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1077, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1078, - "name": "price_lists", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of price lists details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/price-list.ts", - "qualifiedName": "PriceList" - }, - "name": "PriceList", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1078 - ] - } - ] - } - } - ] - } - }, - { - "id": 1079, - "name": "AdminPriceListsProductsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of products with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1080, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1081, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of products details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product.ts", - "qualifiedName": "Product" - }, - "name": "Product", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1081 - ] - } - ] - } - } - ] - } - }, - { - "id": 1164, - "name": "AdminProductCategoriesCategoryDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 1161, - "name": "AdminProductCategoriesCategoryRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product category's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1162, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1163, - "name": "product_category", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product category details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", - "qualifiedName": "ProductCategory" - }, - "name": "ProductCategory", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1163 - ] - } - ] - } - } - }, - { - "id": 1165, - "name": "AdminProductCategoriesListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of product categories with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1166, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1167, - "name": "product_categories", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product category details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", - "qualifiedName": "ProductCategory" - }, - "name": "ProductCategory", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1167 - ] - } - ] - } - } - ] - } - }, - { - "id": 1238, - "name": "AdminProductTagsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of product tags with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1239, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1240, - "name": "product_tags", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product tag details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-tag.ts", - "qualifiedName": "ProductTag" - }, - "name": "ProductTag", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1240 - ] - } - ] - } - } - ] - } - }, - { - "id": 1260, - "name": "AdminProductTypesListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of product types with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1261, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1262, - "name": "product_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product types details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-type.ts", - "qualifiedName": "ProductType" - }, - "name": "ProductType", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1262 - ] - } - ] - } - } - ] - } - }, - { - "id": 1314, - "name": "AdminProductsDeleteOptionRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of deleting a product's option." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1315, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1318, - "name": "deleted", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether or not the items were deleted." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": true - }, - { - "id": 1317, - "name": "object", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the object that was deleted." - } - ] - }, - "type": { - "type": "literal", - "value": "option" - }, - "defaultValue": "option" - }, - { - "id": 1316, - "name": "option_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the deleted Product Option" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1319, - "name": "product", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product.ts", - "qualifiedName": "Product" - }, - "name": "Product", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1318, - 1317, - 1316, - 1319 - ] - } - ] - } - } - }, - { - "id": 1326, - "name": "AdminProductsDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of deleting a product." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1327, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1330, - "name": "deleted", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether or not the items were deleted." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": true - }, - { - "id": 1328, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the deleted Product." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1329, - "name": "object", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the object that was deleted." - } - ] - }, - "type": { - "type": "literal", - "value": "product" - }, - "defaultValue": "product" - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1330, - 1328, - 1329 - ] - } - ] - } - } - }, - { - "id": 1320, - "name": "AdminProductsDeleteVariantRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of deleting a product's variant." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1321, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1324, - "name": "deleted", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether or not the items were deleted." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": true - }, - { - "id": 1323, - "name": "object", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the object that was deleted." - } - ] - }, - "type": { - "type": "literal", - "value": "product-variant" - }, - "defaultValue": "product-variant" - }, - { - "id": 1325, - "name": "product", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product.ts", - "qualifiedName": "Product" - }, - "name": "Product", - "package": "@medusajs/medusa" - } - }, - { - "id": 1322, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the deleted Product Variant." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1324, - 1323, - 1325, - 1322 - ] - } - ] - } - } - }, - { - "id": 1331, - "name": "AdminProductsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of products with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1332, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1333, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of products details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 4562, - "name": "PricedProduct", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product.ts", - "qualifiedName": "Product" - }, - "name": "Product", - "package": "@medusajs/medusa" - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1333 - ] - } - ] - } - } - ] - } - }, - { - "id": 1340, - "name": "AdminProductsListTagsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The usage details of product tags." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1341, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1342, - "name": "tags", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product tags details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-tag.ts", - "qualifiedName": "ProductTag" - }, - "name": "ProductTag", - "package": "@medusajs/medusa" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "id" - }, - { - "type": "literal", - "value": "value" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 1343, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1344, - "name": "usage_count", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of products that use this tag." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1344 - ] - } - ] - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1342 - ] - } - ] - } - } - }, - { - "id": 1337, - "name": "AdminProductsListTypesRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1338, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1339, - "name": "types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product types details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-type.ts", - "qualifiedName": "ProductType" - }, - "name": "ProductType", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1339 - ] - } - ] - } - } - }, - { - "id": 1334, - "name": "AdminProductsListVariantsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1335, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1336, - "name": "variants", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product variants details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-variant.ts", - "qualifiedName": "ProductVariant" - }, - "name": "ProductVariant", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1336 - ] - } - ] - } - } - ] - } - }, - { - "id": 1345, - "name": "AdminProductsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1346, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1347, - "name": "product", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product.ts", - "qualifiedName": "Product" - }, - "name": "Product", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1347 - ] - } - ] - } - } - }, - { - "id": 1503, - "name": "AdminPublishableApiKeyDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 1500, - "name": "AdminPublishableApiKeysListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of publishable API keys with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1501, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1502, - "name": "publishable_api_keys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of publishable API keys details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/publishable-api-key.ts", - "qualifiedName": "PublishableApiKey" - }, - "name": "PublishableApiKey", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1502 - ] - } - ] - } - } - ] - } - }, - { - "id": 1504, - "name": "AdminPublishableApiKeysListSalesChannelsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of sales channel." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1505, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1506, - "name": "sales_channels", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of sales channels details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", - "qualifiedName": "SalesChannel" - }, - "name": "SalesChannel", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1506 - ] - } - ] - } - } - }, - { - "id": 1497, - "name": "AdminPublishableApiKeysRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The publishable API key's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1498, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1499, - "name": "publishable_api_key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Publishable API key details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/publishable-api-key.ts", - "qualifiedName": "PublishableApiKey" - }, - "name": "PublishableApiKey", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1499 - ] - } - ] - } - } - }, { "id": 1020, "name": "AdminRefundRes", @@ -94147,18207 +29050,780 @@ } }, { - "id": 1544, - "name": "AdminRegionsDeleteRes", + "id": 1028, + "name": "AdminPostPaymentRefundsReq", "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 1541, - "name": "AdminRegionsListRes", - "variant": "declaration", - "kind": 2097152, + "kind": 128, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The list of regions with pagination fields." + "text": "The details of the refund to create." } - ], - "modifierTags": [ - "@interface" ] }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1542, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1543, - "name": "regions", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of regions details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/region.ts", - "qualifiedName": "Region" - }, - "name": "Region", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1543 - ] - } - ] - } - } - ] - } - }, - { - "id": 1538, - "name": "AdminRegionsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The region's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1539, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1540, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Region details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/region.ts", - "qualifiedName": "Region" - }, - "name": "Region", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1540 - ] - } - ] - } - } - }, - { - "id": 1664, - "name": "AdminReservationsDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 1659, - "name": "AdminReservationsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of reservations with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1660, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1661, - "name": "reservations", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of reservations details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4689, - "name": "ReservationItemDTO", - "package": "@medusajs/types" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1661 - ] - } - ] - } - } - ] - } - }, - { - "id": 1652, - "name": "AdminReservationsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The reservation's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1653, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1654, - "name": "reservation", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Reservation details." - } - ] - }, - "type": { - "type": "reference", - "target": 4689, - "name": "ReservationItemDTO", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1654 - ] - } - ] - } - } - }, - { - "id": 1612, - "name": "AdminReturnReasonsDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 1609, - "name": "AdminReturnReasonsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of return reasons." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1610, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1611, - "name": "return_reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of return reasons." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/return-reason.ts", - "qualifiedName": "ReturnReason" - }, - "name": "ReturnReason", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1611 - ] - } - ] - } - } - }, - { - "id": 1606, - "name": "AdminReturnReasonsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The return reason's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1607, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1608, - "name": "return_reason", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The return reason's details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/return-reason.ts", - "qualifiedName": "ReturnReason" - }, - "name": "ReturnReason", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1608 - ] - } - ] - } - } - }, - { - "id": 1632, - "name": "AdminReturnsCancelRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated order's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1633, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1634, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Order details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "Order" - }, - "name": "Order", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1634 - ] - } - ] - } - } - }, - { - "id": 1635, - "name": "AdminReturnsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of returns with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1636, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1637, - "name": "returns", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of returns details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/return.ts", - "qualifiedName": "Return" - }, - "name": "Return", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1637 - ] - } - ] - } - } - ] - } - }, - { - "id": 1638, - "name": "AdminReturnsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The return's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1639, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1640, - "name": "return", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/return.ts", - "qualifiedName": "Return" - }, - "name": "Return", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1640 - ] - } - ] - } - } - }, - { - "id": 1700, - "name": "AdminSalesChannelsDeleteLocationRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 1699, - "name": "AdminSalesChannelsDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 1701, - "name": "AdminSalesChannelsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of sales channels with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1702, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1703, - "name": "sales_channels", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of sales channels details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", - "qualifiedName": "SalesChannel" - }, - "name": "SalesChannel", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1703 - ] - } - ] - } - } - ] - } - }, - { - "id": 1696, - "name": "AdminSalesChannelsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The sales channel's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1697, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1698, - "name": "sales_channel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sales Channel's details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", - "qualifiedName": "SalesChannel" - }, - "name": "SalesChannel", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1698 - ] - } - ] - } - } - }, - { - "id": 1755, - "name": "AdminShippingOptionsDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 1749, - "name": "AdminShippingOptionsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of shipping options with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1750, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1751, - "name": "shipping_options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of shipping options details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", - "qualifiedName": "ShippingOption" - }, - "name": "ShippingOption", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1751 - ] - } - ] - } - } - ] - } - }, - { - "id": 1752, - "name": "AdminShippingOptionsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The shipping option's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1753, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1754, - "name": "shipping_option", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Shipping option details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", - "qualifiedName": "ShippingOption" - }, - "name": "ShippingOption", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1754 - ] - } - ] - } - } - }, - { - "id": 1793, - "name": "AdminShippingProfilesListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of shipping profiles." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1794, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1795, - "name": "shipping_profiles", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of shipping profiles details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", - "qualifiedName": "ShippingProfile" - }, - "name": "ShippingProfile", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1795 - ] - } - ] - } - } - }, - { - "id": 1790, - "name": "AdminShippingProfilesRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The shipping profile's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1791, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1792, - "name": "shipping_profile", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Shipping profile details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", - "qualifiedName": "ShippingProfile" - }, - "name": "ShippingProfile", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1792 - ] - } - ] - } - } - }, - { - "id": 1812, - "name": "AdminStockLocationsDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 4723, - "name": "DeleteResponse", - "package": "@medusajs/types" - } - }, - { - "id": 1816, - "name": "AdminStockLocationsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of stock locations with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 4418, - "name": "PaginatedResponse", - "package": "@medusajs/types" - }, - { - "type": "reflection", - "declaration": { - "id": 1817, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1818, - "name": "stock_locations", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of stock locations." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4728, - "name": "StockLocationTypes.StockLocationExpandedDTO", - "package": "@medusajs/types", - "qualifiedName": "StockLocationExpandedDTO" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1818 - ] - } - ] - } - } - ] - } - }, - { - "id": 1813, - "name": "AdminStockLocationsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The stock location's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1814, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1815, - "name": "stock_location", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location details." - } - ] - }, - "type": { - "type": "reference", - "target": 4728, - "name": "StockLocationTypes.StockLocationExpandedDTO", - "package": "@medusajs/types", - "qualifiedName": "StockLocationExpandedDTO" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1815 - ] - } - ] - } - } - }, - { - "id": 1864, - "name": "AdminStoresRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The store's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1865, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1866, - "name": "store", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Store details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/store.ts", - "qualifiedName": "Store" - }, - "name": "Store", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1866 - ] - } - ] - } - } - }, - { - "id": 1885, - "name": "AdminSwapsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of swaps with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1886, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1887, - "name": "swaps", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of swaps details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/swap.ts", - "qualifiedName": "Swap" - }, - "name": "Swap", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1887 - ] - } - ] - } - } - ] - } - }, - { - "id": 1888, - "name": "AdminSwapsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The swap's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1889, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1890, - "name": "swap", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Swap details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/swap.ts", - "qualifiedName": "Swap" - }, - "name": "Swap", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1890 - ] - } - ] - } - } - }, - { - "id": 1867, - "name": "AdminTaxProvidersList", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of tax providers in a store." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1868, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1869, - "name": "tax_providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of tax providers details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/tax-provider.ts", - "qualifiedName": "TaxProvider" - }, - "name": "TaxProvider", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1869 - ] - } - ] - } - } - }, - { - "id": 1898, - "name": "AdminTaxRatesDeleteRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 3904, - "name": "DeleteResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 1899, - "name": "AdminTaxRatesListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of tax rates with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 1900, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1901, - "name": "tax_rates", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of tax rate details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", - "qualifiedName": "TaxRate" - }, - "name": "TaxRate", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1901 - ] - } - ] - } - } - ] - } - }, - { - "id": 1902, - "name": "AdminTaxRatesRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax rate's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1903, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1904, - "name": "tax_rate", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Tax rate details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", - "qualifiedName": "TaxRate" - }, - "name": "TaxRate", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1904 - ] - } - ] - } - } - }, - { - "id": 2009, - "name": "AdminUploadsDownloadUrlRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The download URL details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2010, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2011, - "name": "download_url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Download URL of the file" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2011 - ] - } - ] - } - } - }, - { - "id": 2005, - "name": "AdminUploadsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of uploaded files." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2006, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2007, - "name": "uploads", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Uploaded files details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4759, - "name": "FileServiceUploadResult", - "package": "@medusajs/types" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2007 - ] - } - ] - } - } - }, - { - "id": 2028, - "name": "AdminUserRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The user's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2029, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2030, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "User details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/user.ts", - "qualifiedName": "User" - }, - "name": "User", - "package": "@medusajs/medusa" - }, - { - "type": "literal", - "value": "password_hash" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2030 - ] - } - ] - } - } - }, - { - "id": 2031, - "name": "AdminUsersListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of users." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2032, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2033, - "name": "users", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of users details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/user.ts", - "qualifiedName": "User" - }, - "name": "User", - "package": "@medusajs/medusa" - }, - { - "type": "literal", - "value": "password_hash" - } - ], - "name": "Omit", - "package": "typescript" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2033 - ] - } - ] - } - } - }, - { - "id": 2068, - "name": "AdminVariantsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of variants with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 2069, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2070, - "name": "variants", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product variant details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4763, - "name": "PricedVariant", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2070 - ] - } - ] - } - } - ] - } - }, - { - "id": 2071, - "name": "AdminVariantsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product variant's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2072, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2073, - "name": "variant", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product variant's details." - } - ] - }, - "type": { - "type": "reference", - "target": 4763, - "name": "PricedVariant", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2073 - ] - } - ] - } - } - }, - { - "id": 3832, - "name": "BatchJobCreateProps", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/batch-job.ts", - "qualifiedName": "BatchJob" - }, - "name": "BatchJob", - "package": "@medusajs/medusa" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "context" - }, - { - "type": "literal", - "value": "type" - }, - { - "type": "literal", - "value": "created_by" - }, - { - "type": "literal", - "value": "dry_run" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - }, - { - "id": 3812, - "name": "BatchJobResultError", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3813, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3815, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 3814, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3815, - 3814 - ] - } - ], - "indexSignature": { - "id": 3816, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 3817, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - } - } - }, - { - "id": 3818, - "name": "BatchJobResultStatDescriptor", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3819, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3820, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3822, - "name": "message", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3821, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3820, - 3822, - 3821 - ] - } - ] - } - } - }, - { - "id": 3806, - "name": "BatchJobUpdateProps", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/batch-job.ts", - "qualifiedName": "BatchJob" - }, - "name": "BatchJob", - "package": "@medusajs/medusa" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "context" - }, - { - "type": "literal", - "value": "result" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - } - }, - { - "id": 2814, - "name": "CartCompletionResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2815, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2817, - "name": "response_body", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The response body for the completion request" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 2816, - "name": "response_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The response code for the completion request" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2817, - 2816 - ] - } - ] - } - } - }, - { - "id": 3977, - "name": "ClassConstructor", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ + "children": [ { - "id": 3981, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3978, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3979, - "name": "new ClassConstructor", - "variant": "signature", - "kind": 16384, - "flags": {}, - "parameters": [ - { - "id": 3980, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "type": { - "type": "reference", - "target": 3981, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ] - } - } - }, - { - "id": 4046, - "name": "ConfigModule", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": 4954, - "name": "CommonTypes.ConfigModule", - "package": "@medusajs/types", - "qualifiedName": "ConfigModule" - } - }, - { - "id": 4954, - "name": "ConfigModule", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4955, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4957, - "name": "featureFlags", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4958, - "name": "modules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 5120, - "name": "InternalModuleDeclaration", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 5130, - "name": "ExternalModuleDeclaration", - "package": "@medusajs/types" - } - ] - } - ], - "name": "Partial", - "package": "typescript" - } - ] - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4959, - "name": "plugins", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 4960, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4962, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4961, - "name": "resolve", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4962, - 4961 - ] - } - ] - } - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - }, - { - "id": 4956, - "name": "projectConfig", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 5099, - "name": "ProjectConfigOptions", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4957, - 4958, - 4959, - 4956 - ] - } - ] - } - } - }, - { - "id": 4041, - "name": "Constructor", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 4045, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 4042, - "name": "__type", + "id": 1029, + "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 4043, - "name": "__type", + "id": 1030, + "name": "new AdminPostPaymentRefundsReq", "variant": "signature", "kind": 16384, "flags": {}, - "parameters": [ - { - "id": 4044, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the refund to create." } - } - ], + ] + }, "type": { "type": "reference", - "target": 4045, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true + "target": 1028, + "name": "AdminPostPaymentRefundsReq", + "package": "@medusajs/medusa" } } ] - } - } - }, - { - "id": 4976, - "name": "Constructor", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ + }, { - "id": 4980, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} + "id": 1031, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount to refund." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1032, + "name": "reason", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reason for the Refund." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/refund.ts", + "qualifiedName": "RefundReason" + }, + "name": "RefundReason", + "package": "@medusajs/medusa" + } + }, + { + "id": 1033, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A note with additional details about the Refund." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } } ], - "type": { - "type": "reflection", - "declaration": { - "id": 4977, - "name": "__type", + "groups": [ + { + "title": "Constructors", + "children": [ + 1029 + ] + }, + { + "title": "Properties", + "children": [ + 1031, + 1032, + 1033 + ] + } + ] + }, + { + "id": 1082, + "name": "AdminPostPriceListPricesPricesReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the prices to add." + } + ] + }, + "children": [ + { + "id": 1083, + "name": "constructor", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 4978, - "name": "__type", + "id": 1084, + "name": "new AdminPostPriceListPricesPricesReq", "variant": "signature", "kind": 16384, "flags": {}, - "parameters": [ - { - "id": 4979, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the prices to add." } - } - ], - "type": { - "type": "reference", - "target": 4980, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - ] - } - } - }, - { - "id": 3807, - "name": "CreateBatchJobInput", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3808, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3810, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "context" - }, - "objectType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/batch-job.ts", - "qualifiedName": "BatchJob" - }, - "name": "BatchJob", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 3811, - "name": "dry_run", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3809, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3810, - 3811, - 3809 - ] - } - ] - } - } - }, - { - "id": 4099, - "name": "CreatePriceListInput", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4100, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4106, - "name": "customer_groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 4107, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4108, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4108 - ] - } - ] - } - } - } - }, - { - "id": 4102, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4110, - "name": "ends_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true + ] }, "type": { "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 4111, - "name": "includes_tax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4101, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4105, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4090, - "name": "AdminPriceListPricesCreateReq", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 4109, - "name": "starts_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 4104, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 4064, - "name": "PriceListStatus", - "package": "@medusajs/medusa" - } - }, - { - "id": 4103, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 4061, - "name": "PriceListType", + "target": 1082, + "name": "AdminPostPriceListPricesPricesReq", "package": "@medusajs/medusa" } } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4106, - 4102, - 4110, - 4111, - 4101, - 4105, - 4109, - 4104, - 4103 - ] - } ] - } - } - }, - { - "id": 4877, - "name": "CreateReturnType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/return.ts", - "qualifiedName": "Return" - }, - "name": "Return", - "package": "@medusajs/medusa" - }, - { - "type": "literal", - "value": "beforeInsert" - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 3350, - "name": "Data", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 494, - "name": "DecoratedInventoryItemDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 4386, - "name": "InventoryItemDTO", - "package": "@medusajs/types" - }, - { - "type": "reflection", - "declaration": { - "id": 495, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 496, - "name": "location_levels", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of location level details" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4406, - "name": "InventoryLevelDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 499, - "name": "reserved_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total quantity of the item available across levels" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 498, - "name": "stocked_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total quantity of the item in stock across levels" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 497, - "name": "variants", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product variant details" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-variant.ts", - "qualifiedName": "ProductVariant" - }, - "name": "ProductVariant", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 496, - 499, - 498, - 497 - ] - } - ] - } - } - ] - } - }, - { - "id": 4848, - "name": "DeleteFileType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4849, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4850, - "name": "fileKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4850 - ] - } - ], - "indexSignature": { - "id": 4851, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 4852, - "name": "x", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - } - } - }, - { - "id": 4723, - "name": "DeleteResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The fields returned in the response of a DELETE request." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 4724, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4727, - "name": "deleted", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the item was deleted successfully." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": true - }, - { - "id": 4725, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the item that was deleted." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4726, - "name": "object", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the item that was deleted." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "stock_location" - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4727, - 4725, - 4726 - ] - } - ] - } - } - }, - { - "id": 5063, - "name": "DiscountAllocation", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount of a discount allocated to a line item" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 5064, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5065, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 5066, - "name": "unit_amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5065, - 5066 - ] - } - ] - } - } - }, - { - "id": 3857, - "name": "ExtendedFindConfig", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ { - "id": 3865, - "name": "TEntity", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "union", - "types": [ + "id": 1085, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOneOptions.d.ts", - "qualifiedName": "FindOneOptions" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3865, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "FindOneOptions", - "package": "typeorm" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "where" - }, - { - "type": "literal", - "value": "relations" - }, - { - "type": "literal", - "value": "select" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindManyOptions.d.ts", - "qualifiedName": "FindManyOptions" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3865, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "FindManyOptions", - "package": "typeorm" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "where" - }, - { - "type": "literal", - "value": "relations" - }, - { - "type": "literal", - "value": "select" - } - ] - } - ], - "name": "Omit", - "package": "typescript" + "kind": "text", + "text": "The prices to update or add." } ] }, - { - "type": "reflection", - "declaration": { - "id": 3858, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3862, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsOrder.d.ts", - "qualifiedName": "FindOptionsOrder" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3865, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsOrder", - "package": "typeorm" - } - }, - { - "id": 3860, - "name": "relations", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsRelations.d.ts", - "qualifiedName": "FindOptionsRelations" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3865, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsRelations", - "package": "typeorm" - } - }, - { - "id": 3859, - "name": "select", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsSelect.d.ts", - "qualifiedName": "FindOptionsSelect" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3865, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsSelect", - "package": "typeorm" - } - }, - { - "id": 3863, - "name": "skip", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3864, - "name": "take", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3861, - "name": "where", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", - "qualifiedName": "FindOptionsWhere" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3865, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsWhere", - "package": "typeorm" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", - "qualifiedName": "FindOptionsWhere" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3865, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsWhere", - "package": "typeorm" - } - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3862, - 3860, - 3859, - 3863, - 3864, - 3861 - ] - } - ] - } - } - ] - } - }, - { - "id": 3973, - "name": "ExtendedRequest", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 3976, - "name": "TEntity", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Request" - }, - "name": "Request", - "package": "@types/express", - "qualifiedName": "e.Request" - }, - { - "type": "reflection", - "declaration": { - "id": 3974, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3975, - "name": "resource", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 3976, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3975 - ] - } - ] - } - } - ] - } - }, - { - "id": 1655, - "name": "ExtendedReservationItem", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 4689, - "name": "ReservationItemDTO", - "package": "@medusajs/types" - }, - { - "type": "reflection", - "declaration": { - "id": 1656, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1658, - "name": "inventory_item", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The inventory item associated with the reservation." - } - ] - }, - "type": { - "type": "reference", - "target": 4386, - "name": "InventoryItemDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1657, - "name": "line_item", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The line item associated with the reservation." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", - "qualifiedName": "LineItem" - }, - "name": "LineItem", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1658, - 1657 - ] - } - ] - } - } - ] - } - }, - { - "id": 4753, - "name": "ExtendedStoreDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/store.ts", - "qualifiedName": "Store" - }, - "name": "Store", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 4754, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4757, - "name": "feature_flags", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The feature flags enabled in the store's backend." - } - ] - }, - "type": { - "type": "reference", - "target": 5041, - "name": "FeatureFlagsResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 4756, - "name": "fulfillment_providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The store's fulfillment providers." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/fulfillment-provider.ts", - "qualifiedName": "FulfillmentProvider" - }, - "name": "FulfillmentProvider", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 4758, - "name": "modules", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The modules installed in the store's backend." - } - ] - }, - "type": { - "type": "reference", - "target": 5045, - "name": "ModulesResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 4755, - "name": "payment_providers", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The store's payment providers." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-provider.ts", - "qualifiedName": "PaymentProvider" - }, - "name": "PaymentProvider", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4757, - 4756, - 4758, - 4755 - ] - } - ] - } - } - ] - } - }, - { - "id": 5130, - "name": "ExternalModuleDeclaration", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5131, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5140, - "name": "alias", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If multiple modules are registered with the same key, the alias can be used to differentiate them" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5133, - "name": "definition", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 5222, - "name": "ModuleDefinition", - "package": "@medusajs/types" - } - }, - { - "id": 5141, - "name": "main", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the module is the main module for the key when multiple ones are registered" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5139, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 5132, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 5234, - "name": "MODULE_SCOPE.EXTERNAL", - "package": "@medusajs/types" - } - }, - { - "id": 5134, - "name": "server", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 5135, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5138, - "name": "keepAlive", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5136, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "literal", - "value": "http" - } - }, - { - "id": 5137, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5138, - 5136, - 5137 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5140, - 5133, - 5141, - 5139, - 5132, - 5134 - ] - } - ] - } - } - }, - { - "id": 5041, - "name": "FeatureFlagsResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 5042, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5043, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5044, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "boolean" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5043, - 5044 - ] - } - ] - } - } - } - }, - { - "id": 4860, - "name": "FileServiceGetUploadStreamResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4861, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4865, - "name": "fileKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4863, - "name": "promise", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 4864, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4862, - "name": "writeStream", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/@types/node/stream.d.ts", - "qualifiedName": "internal.PassThrough" - }, - "name": "stream.PassThrough", - "package": "@types/node", - "qualifiedName": "internal.PassThrough" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4865, - 4863, - 4864, - 4862 - ] - } - ], - "indexSignature": { - "id": 4866, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 4867, - "name": "x", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - } - } - }, - { - "id": 4759, - "name": "FileServiceUploadResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4760, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4762, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The key of the file that is identifiable by the file service. It can be used later to retrieve or manipulate the file." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4761, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The URL of the uploaded file." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4762, - 4761 - ] - } - ] - } - } - }, - { - "id": 4875, - "name": "FulfillmentProviderData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4868, - "name": "GetUploadedFileType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4869, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4870, - "name": "fileKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4871, - "name": "isPrivate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4870, - 4871 - ] - } - ], - "indexSignature": { - "id": 4872, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 4873, - "name": "x", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - } - } - }, - { - "id": 5059, - "name": "GiftCardAllocation", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount of a gift card allocated to a line item" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 5060, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5061, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 5062, - "name": "unit_amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5061, - 5062 - ] - } - ] - } - } - }, - { - "id": 5212, - "name": "HttpCompressionOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5213, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5214, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5215, - "name": "level", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 5216, - "name": "memLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 5217, - "name": "threshold", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5214, - 5215, - 5216, - 5217 - ] - } - ] - } - } - }, - { - "id": 4952, - "name": "InnerSelector", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 4953, - "name": "TEntity", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "mapped", - "parameter": "key", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4953, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "union", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "key" - }, - "name": "key", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 4953, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "key" - }, - "name": "key", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 4953, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - }, - { - "type": "reference", - "target": 3911, - "name": "DateComparisonOperator", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3918, - "name": "StringComparisonOperator", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3928, - "name": "NumericalComparisonOperator", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", - "qualifiedName": "FindOperator" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "key" - }, - "name": "key", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 4953, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "name": "FindOperator", - "package": "typeorm" - } - ] - }, - "optionalModifier": "+" - } - }, - { - "id": 5120, - "name": "InternalModuleDeclaration", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5121, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5128, - "name": "alias", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If multiple modules are registered with the same key, the alias can be used to differentiate them" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5125, - "name": "definition", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 5222, - "name": "ModuleDefinition", - "package": "@medusajs/types" - } - }, - { - "id": 5124, - "name": "dependencies", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 5129, - "name": "main", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the module is the main module for the key when multiple ones are registered" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5127, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 5126, - "name": "resolve", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5123, - "name": "resources", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 5219, - "name": "MODULE_RESOURCE_TYPE", - "package": "@medusajs/types" - } - }, - { - "id": 5122, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 5218, - "name": "MODULE_SCOPE.INTERNAL", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5128, - 5125, - 5124, - 5129, - 5127, - 5126, - 5123, - 5122 - ] - } - ] - } - } - }, - { - "id": 4386, - "name": "InventoryItemDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 4387, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4403, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was created." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 4405, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4400, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description of the inventory item" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4397, - "name": "height", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The height of the Inventory Item. May be used in shipping rate calculations." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4391, - "name": "hs_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4388, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The inventory item's ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4396, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The length of the Inventory Item. May be used in shipping rate calculations." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4394, - "name": "material", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4402, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional key-value map with additional details" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4393, - "name": "mid_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "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": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4390, - "name": "origin_country", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4392, - "name": "requires_shipping", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the item requires shipping." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4389, - "name": "sku", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Stock Keeping Unit (SKU) code of the Inventory Item." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4401, - "name": "thumbnail", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Thumbnail for the inventory item" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4399, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Title of the inventory item" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4404, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was updated." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 4395, - "name": "weight", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The weight of the Inventory Item. May be used in shipping rate calculations." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4398, - "name": "width", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The width of the Inventory Item. May be used in shipping rate calculations." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4403, - 4405, - 4400, - 4397, - 4391, - 4388, - 4396, - 4394, - 4402, - 4393, - 4390, - 4392, - 4389, - 4401, - 4399, - 4404, - 4395, - 4398 - ] - } - ] - } - } - }, - { - "id": 4406, - "name": "InventoryLevelDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 4407, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4415, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was created." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 4417, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4408, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4413, - "name": "incoming_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the incoming stock quantity of an inventory item at the given location ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4409, - "name": "inventory_item_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4410, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the item location ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4414, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional key-value map with additional details" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4412, - "name": "reserved_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the reserved stock quantity of an inventory item at the given location ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4411, - "name": "stocked_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the total stock quantity of an inventory item at the given location ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4416, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was updated." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4415, - 4417, - 4408, - 4413, - 4409, - 4410, - 4414, - 4412, - 4411, - 4416 - ] - } - ] - } - } - }, - { - "id": 3693, - "name": "ItemTaxCalculationLine", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A line item and the tax rates that have been configured to apply to the\nproduct contained in the line item." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3694, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3695, - "name": "item", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", - "qualifiedName": "LineItem" - }, - "name": "LineItem", - "package": "@medusajs/medusa" - } - }, - { - "id": 3696, - "name": "rates", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4910, - "name": "TaxServiceRate", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3695, - 3696 - ] - } - ] - } - } - }, - { - "id": 5194, - "name": "JoinerRelationship", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5195, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5196, - "name": "alias", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5203, - "name": "args", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extra arguments to pass to the remoteFetchData callback" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 5197, - "name": "foreignKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5201, - "name": "inverse", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "In an inverted relationship the foreign key is on the other service and the primary key is on the current service" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5200, - "name": "isInternalService", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5202, - "name": "isList", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Force the relationship to return a list" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5198, - "name": "primaryKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5199, - "name": "serviceName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5196, - 5203, - 5197, - 5201, - 5200, - 5202, - 5198, - 5199 - ] - } - ] - } - } - }, - { - "id": 2094, - "name": "LevelWithAvailability", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 4406, - "name": "InventoryLevelDTO", - "package": "@medusajs/types" - }, - { - "type": "reflection", - "declaration": { - "id": 2095, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2096, - "name": "available_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2096 - ] - } - ] - } - } - ] - } - }, - { - "id": 4917, - "name": "LineAllocationsMap", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A map of line item ids and its corresponding gift card and discount\nallocations" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 4918, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "indexSignature": { - "id": 4919, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 4920, - "name": "K", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 4921, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4923, - "name": "discount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 5063, - "name": "DiscountAllocation", - "package": "@medusajs/medusa" - } - }, - { - "id": 4922, - "name": "gift_card", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 5059, - "name": "GiftCardAllocation", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4923, - 4922 - ] - } - ] - } - } - } - } - } - }, - { - "id": 3983, - "name": "Logger", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3984, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4000, - "name": "activity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4001, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4002, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4003, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4004, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 4025, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4026, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4027, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4028, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 4010, - "name": "error", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4011, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4012, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4013, - "name": "messageOrError", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 4014, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 4015, - "name": "failure", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4016, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4017, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4018, - "name": "activityId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 4019, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 4029, - "name": "info", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4030, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4031, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4032, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 4037, - "name": "log", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4038, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4039, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4040, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 3985, - "name": "panic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3986, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3987, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3988, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 4005, - "name": "progress", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4006, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4007, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4008, - "name": "activityId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 4009, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 3993, - "name": "setLogLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3994, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3995, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3996, - "name": "level", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 3989, - "name": "shouldLog", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3990, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3991, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3992, - "name": "level", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 4020, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4021, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4022, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4023, - "name": "activityId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 4024, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 3997, - "name": "unsetLogLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3998, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 3999, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 4033, - "name": "warn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4034, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4035, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4036, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4000, - 4025, - 4010, - 4015, - 4029, - 4037, - 3985, - 4005, - 3993, - 3989, - 4020, - 3997, - 4033 - ] - } - ] - } - } - }, - { - "id": 3982, - "name": "MedusaContainer", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": 4894, - "name": "coreMedusaContainer", - "package": "medusa-core-utils", - "qualifiedName": "MedusaContainer" - } - }, - { - "id": 4878, - "name": "MedusaContainer", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/awilix/lib/container.d.ts", - "qualifiedName": "AwilixContainer" - }, - "name": "AwilixContainer", - "package": "awilix" - }, - { - "type": "reflection", - "declaration": { - "id": 4879, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4886, - "name": "createScope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4887, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4888, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": 4878, - "name": "MedusaContainer", - "package": "@medusajs/types" - } - } - ] - } - } - }, - { - "id": 4880, - "name": "registerAdd", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4881, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4882, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 4885, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 4883, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4884, - "name": "registration", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4885, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 4878, - "name": "MedusaContainer", - "package": "@medusajs/types" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4886, - 4880 - ] - } - ] - } - } - ] - } - }, - { - "id": 4894, - "name": "MedusaContainer", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/awilix/lib/container.d.ts", - "qualifiedName": "AwilixContainer" - }, - "name": "AwilixContainer", - "package": "awilix" - }, - { - "type": "reflection", - "declaration": { - "id": 4895, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4902, - "name": "createScope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4903, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4904, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": 4894, - "name": "MedusaContainer", - "package": "medusa-core-utils" - } - } - ] - } - } - }, - { - "id": 4896, - "name": "registerAdd", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4897, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4898, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 4901, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 4899, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4900, - "name": "registration", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4901, - "name": "T", - "package": "medusa-core-utils", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 4894, - "name": "MedusaContainer", - "package": "medusa-core-utils" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4902, - 4896 - ] - } - ] - } - } - ] - } - }, - { - "id": 4967, - "name": "MedusaErrorHandlerFunction", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4968, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4969, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4970, - "name": "error", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 4971, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4142, - "name": "MedusaRequest", - "package": "@medusajs/medusa" - } - }, - { - "id": 4972, - "name": "res", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4153, - "name": "MedusaResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 4973, - "name": "next", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4154, - "name": "MedusaNextFunction", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "void" - } - ] - } - } - ] - } - } - }, - { - "id": 4154, - "name": "MedusaNextFunction", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.NextFunction" - }, - "name": "NextFunction", - "package": "@types/express", - "qualifiedName": "e.NextFunction" - } - }, - { - "id": 4155, - "name": "MedusaRequestHandler", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4156, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4157, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4158, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4142, - "name": "MedusaRequest", - "package": "@medusajs/medusa" - } - }, - { - "id": 4159, - "name": "res", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4153, - "name": "MedusaResponse", - "package": "@medusajs/medusa" - } - }, - { - "id": 4160, - "name": "next", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4154, - "name": "MedusaNextFunction", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "void" - } - ] - } - } - ] - } - } - }, - { - "id": 4153, - "name": "MedusaResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Response" - }, - "name": "Response", - "package": "@types/express", - "qualifiedName": "e.Response" - } - }, - { - "id": 4047, - "name": "MiddlewareFunction", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 4155, - "name": "MedusaRequestHandler", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 4048, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4049, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4050, - "name": "args", - "variant": "param", - "kind": 32768, - "flags": { - "isRest": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - ] - } - }, - { - "id": 4051, - "name": "MiddlewareRoute", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4052, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4055, - "name": "bodyParser", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 4964, - "name": "ParserConfig", - "package": "@medusajs/medusa" - } - }, - { - "id": 4054, - "name": "matcher", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "RegExp" - }, - "name": "RegExp", - "package": "typescript" - } - ] - } - }, - { - "id": 4053, - "name": "method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 4963, - "name": "MiddlewareVerb", - "package": "@medusajs/medusa" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 4963, - "name": "MiddlewareVerb", - "package": "@medusajs/medusa" - } - } - ] - } - }, - { - "id": 4056, - "name": "middlewares", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4047, - "name": "MiddlewareFunction", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4055, - 4054, - 4053, - 4056 - ] - } - ] - } - } - }, - { - "id": 4963, - "name": "MiddlewareVerb", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "USE" - }, - { - "type": "literal", - "value": "ALL" - }, - { - "type": "reference", - "target": 5142, - "name": "RouteVerb", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 4057, - "name": "MiddlewaresConfig", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4058, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4059, - "name": "errorHandler", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": false - }, - { - "type": "reference", - "target": 4967, - "name": "MedusaErrorHandlerFunction", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 4060, - "name": "routes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4051, - "name": "MiddlewareRoute", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4059, - 4060 - ] - } - ] - } - } - }, - { - "id": 5222, - "name": "ModuleDefinition", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5223, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5228, - "name": "canOverride", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "property will be removed in future versions" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5233, - "name": "defaultModuleDeclaration", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 5120, - "name": "InternalModuleDeclaration", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 5130, - "name": "ExternalModuleDeclaration", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 5226, - "name": "defaultPackage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ] - } - }, - { - "id": 5232, - "name": "dependencies", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 5231, - "name": "isLegacy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5230, - "name": "isQueryable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5229, - "name": "isRequired", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [], - "blockTags": [ - { - "tag": "@deprecated", - "content": [ - { - "kind": "text", - "text": "property will be removed in future versions" - } - ] - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5224, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5227, - "name": "label", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5225, - "name": "registrationName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5228, - 5233, - 5226, - 5232, - 5231, - 5230, - 5229, - 5224, - 5227, - 5225 - ] - } - ] - } - } - }, - { - "id": 4925, - "name": "ModuleJoinerConfig", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 5081, - "name": "JoinerServiceConfig", - "package": "@medusajs/types" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "serviceName" - }, - { - "type": "literal", - "value": "primaryKeys" - }, - { - "type": "literal", - "value": "relationships" - }, - { - "type": "literal", - "value": "extends" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 4926, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4942, - "name": "databaseConfig", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 4943, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4946, - "name": "extraFields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 4947, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4949, - "name": "defaultValue", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4950, - "name": "nullable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4951, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mikro-orm options for the column" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4948, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "date" - }, - { - "type": "literal", - "value": "time" - }, - { - "type": "literal", - "value": "datetime" - }, - { - "type": "literal", - "value": "bigint" - }, - { - "type": "literal", - "value": "blob" - }, - { - "type": "literal", - "value": "uint8array" - }, - { - "type": "literal", - "value": "array" - }, - { - "type": "literal", - "value": "enumArray" - }, - { - "type": "literal", - "value": "enum" - }, - { - "type": "literal", - "value": "json" - }, - { - "type": "literal", - "value": "integer" - }, - { - "type": "literal", - "value": "smallint" - }, - { - "type": "literal", - "value": "tinyint" - }, - { - "type": "literal", - "value": "mediumint" - }, - { - "type": "literal", - "value": "float" - }, - { - "type": "literal", - "value": "double" - }, - { - "type": "literal", - "value": "boolean" - }, - { - "type": "literal", - "value": "decimal" - }, - { - "type": "literal", - "value": "string" - }, - { - "type": "literal", - "value": "uuid" - }, - { - "type": "literal", - "value": "text" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4949, - 4950, - 4951, - 4948 - ] - } - ] - } - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4945, - "name": "idPrefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prefix for the id column. If not provided it is \"link\"" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4944, - "name": "tableName", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the pivot table. If not provided it is auto generated" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4946, - 4945, - 4944 - ] - } - ] - } - } - }, - { - "id": 4929, - "name": "extends", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 4930, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4932, - "name": "fieldAlias", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 4933, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4935, - "name": "forwardArgumentsOnPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4934, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4935, - 4934 - ] - } - ] - } - } - ] - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4936, - "name": "relationship", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 5095, - "name": "ModuleJoinerRelationship", - "package": "@medusajs/types" - } - }, - { - "id": 4931, - "name": "serviceName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4932, - 4936, - 4931 - ] - } - ] - } - } - } - }, - { - "id": 4939, - "name": "isLink", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the module is a link module" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4941, - "name": "isReadOnlyLink", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true it expands a RemoteQuery property but doesn't create a pivot table" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4940, - "name": "linkableKeys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Keys that can be used to link to other modules. e.g { product_id: \"Product\" } \"Product\" being the entity it refers to" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4938, - "name": "primaryKeys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 4928, - "name": "relationships", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 5095, - "name": "ModuleJoinerRelationship", - "package": "@medusajs/types" - } - } - }, - { - "id": 4927, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "GraphQL schema for the all module's available entities and fields" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4937, - "name": "serviceName", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4942, - 4929, - 4939, - 4941, - 4940, - 4938, - 4928, - 4927, - 4937 - ] - } - ] - } - } - ] - } - }, - { - "id": 5095, - "name": "ModuleJoinerRelationship", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 5194, - "name": "JoinerRelationship", - "package": "@medusajs/types" - }, - { - "type": "reflection", - "declaration": { - "id": 5096, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5098, - "name": "deleteCascade", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the link joiner will cascade deleting the relationship" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5097, - "name": "isInternalService", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the relationship is an internal service from the medusa core TODO: Remove when there are no more \"internal\" services" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5098, - 5097 - ] - } - ] - } - } - ] - } - }, - { - "id": 5045, - "name": "ModulesResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reference", - "target": 5180, - "name": "sdkModulesResponse", - "package": "@medusajs/types", - "qualifiedName": "ModulesResponse" - } - }, - { - "id": 5180, - "name": "ModulesResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 5181, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5182, - "name": "module", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5183, - "name": "resolution", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5182, - 5183 - ] - } - ] - } - } - } - }, - { - "id": 4418, - "name": "PaginatedResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4419, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4422, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The total number of notifications" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4420, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of notifications per page" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4421, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of notifications skipped when retrieving the notifications." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4422, - 4420, - 4421 - ] - } - ] - } - } - }, - { - "id": 4964, - "name": "ParserConfig", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": false - }, - { - "type": "reflection", - "declaration": { - "id": 4965, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4966, - "name": "sizeLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4966 - ] - } - ] - } - } - ] - } - }, - { - "id": 3842, - "name": "PartialPick", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 3843, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 3844, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": {}, "type": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 3843, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "mapped", - "parameter": "P", - "parameterType": { - "type": "reference", - "target": 3844, - "name": "K", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "P" - }, - "name": "P", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 3843, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - "optionalModifier": "+" - } - }, - { - "id": 3353, - "name": "PaymentContext", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3354, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3364, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3355, - "name": "cart", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3356, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3362, - "name": "billing_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/address.ts", - "qualifiedName": "Address" - }, - "name": "Address", - "package": "@medusajs/medusa" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 3357, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3359, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3358, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3360, - "name": "shipping_address", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/address.ts", - "qualifiedName": "Address" - }, - "name": "Address", - "package": "@medusajs/medusa" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 3361, - "name": "shipping_methods", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", - "qualifiedName": "ShippingMethod" - }, - "name": "ShippingMethod", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3362, - 3357, - 3359, - 3358, - 3360, - 3361 - ] - } - ] - } - } - }, - { - "id": 3363, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3366, - "name": "customer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A customer can make purchases in your store and manage their profile." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer.ts", - "qualifiedName": "Customer" - }, - "name": "Customer", - "package": "@medusajs/medusa" - } - }, - { - "id": 3367, - "name": "paymentSessionData", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3365, - "name": "resource_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3364, - 3355, - 3363, - 3366, - 3367, - 3365 - ] - } - ] - } - } - }, - { - "id": 3351, - "name": "PaymentData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - }, - { - "id": 3352, - "name": "PaymentSessionData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": 3350, - "name": "Data", - "package": "@medusajs/medusa" - } - }, - { - "id": 3368, - "name": "PaymentSessionResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3369, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3373, - "name": "session_data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 3370, - "name": "update_requests", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3371, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3372, - "name": "customer_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3372 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3373, - 3370 - ] - } - ] - } - } - }, - { - "id": 4135, - "name": "PriceListLoadConfig", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4136, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4139, - "name": "cart_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4141, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4138, - "name": "customer_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4137, - "name": "include_discount_prices", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4140, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4139, - 4141, - 4138, - 4137, - 4140 - ] - } - ] - } - } - }, - { - "id": 4127, - "name": "PriceListPriceCreateInput", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4128, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4132, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4130, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4134, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4133, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4129, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4131, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4132, - 4130, - 4134, - 4133, - 4129, - 4131 - ] - } - ] - } - } - }, - { - "id": 4118, - "name": "PriceListPriceUpdateInput", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4119, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4124, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4123, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4120, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4126, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4125, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4122, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4121, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4124, - 4123, - 4120, - 4126, - 4125, - 4122, - 4121 - ] - } - ] - } - } - }, - { - "id": 3613, - "name": "PriceSelectionContext", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3614, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3615, - "name": "cart_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3619, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3616, - "name": "customer_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3622, - "name": "ignore_cache", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3620, - "name": "include_discount_prices", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3618, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3617, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 3621, - "name": "tax_rates", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4910, - "name": "TaxServiceRate", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3615, - 3619, - 3616, - 3622, - 3620, - 3618, - 3617, - 3621 - ] - } - ] - } - } - }, - { - "id": 3629, - "name": "PriceSelectionResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3630, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3633, - "name": "calculatedPrice", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 3634, - "name": "calculatedPriceIncludesTax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 3635, - "name": "calculatedPriceType", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 3628, - "name": "PriceType", - "package": "@medusajs/medusa" - } - }, - { - "id": 3631, - "name": "originalPrice", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 3632, - "name": "originalPriceIncludesTax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 3636, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", - "qualifiedName": "MoneyAmount" - }, - "name": "MoneyAmount", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3633, - 3634, - 3635, - 3631, - 3632, - 3636 - ] - } - ] - } - } - }, - { - "id": 3628, - "name": "PriceType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 4916, - "name": "DefaultPriceType", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 4061, - "name": "PriceListType", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 4562, - "name": "PricedProduct", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product.ts", - "qualifiedName": "Product" - }, - "name": "Product", - "package": "@medusajs/medusa" - } - ], - "name": "Partial", - "package": "typescript" - }, - { - "type": "literal", - "value": "variants" - } - ], - "name": "Omit", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 4563, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4564, - "name": "variants", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product variants and their prices." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4763, - "name": "PricedVariant", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4564 - ] - } - ] - } - } - ] - } - }, - { - "id": 4800, - "name": "PricedShippingOption", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", - "qualifiedName": "ShippingOption" - }, - "name": "ShippingOption", - "package": "@medusajs/medusa" - } - ], - "name": "Partial", - "package": "typescript" - }, - { - "type": "reference", - "target": 5054, - "name": "ShippingOptionPricing", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 4763, - "name": "PricedVariant", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-variant.ts", - "qualifiedName": "ProductVariant" - }, - "name": "ProductVariant", - "package": "@medusajs/medusa" - } - ], - "name": "Partial", - "package": "typescript" - }, - { - "type": "reference", - "target": 5046, - "name": "ProductVariantPricing", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 5046, - "name": "ProductVariantPricing", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pricing fields for product variants." - } - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 5047, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5050, - "name": "calculated_price", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The lowest price among the retrieved prices." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5052, - "name": "calculated_price_includes_tax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the " - }, - { - "kind": "code", - "text": "`calculated_price`" - }, - { - "kind": "text", - "text": " field includes taxes." - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "text", - "text": "tax_inclusive_pricing" - } - ] - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5053, - "name": "calculated_price_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Either " - }, - { - "kind": "code", - "text": "`default`" - }, - { - "kind": "text", - "text": " if the " - }, - { - "kind": "code", - "text": "`calculated_price`" - }, - { - "kind": "text", - "text": " is the original price, or the type of the price list applied, if any." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5049, - "name": "original_price", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The original price of the variant." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5051, - "name": "original_price_includes_tax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the " - }, - { - "kind": "code", - "text": "`original_price`" - }, - { - "kind": "text", - "text": " field includes taxes." - } - ], - "blockTags": [ - { - "tag": "@featureFlag", - "content": [ - { - "kind": "text", - "text": "tax_inclusive_pricing" - } - ] - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5048, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of prices." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", - "qualifiedName": "MoneyAmount" - }, - "name": "MoneyAmount", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5050, - 5052, - 5053, - 5049, - 5051, - 5048 - ] - } - ] - } - }, - { - "type": "reference", - "target": 5184, - "name": "TaxedPricing", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 5099, - "name": "ProjectConfigOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5100, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5119, - "name": "admin_cors", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5106, - "name": "cookie_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5108, - "name": "database_database", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5113, - "name": "database_extra", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 5114, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5115, - "name": "ssl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5116, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5117, - "name": "rejectUnauthorized", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "literal", - "value": false - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5117 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5115 - ] - } - ] - } - } - ] - } - }, - { - "id": 5110, - "name": "database_logging", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/logger/LoggerOptions.d.ts", - "qualifiedName": "LoggerOptions" - }, - "name": "LoggerOptions", - "package": "typeorm" - } - }, - { - "id": 5109, - "name": "database_schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5111, - "name": "database_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5107, - "name": "database_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5112, - "name": "http_compression", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 5212, - "name": "HttpCompressionOptions", - "package": "@medusajs/types" - } - }, - { - "id": 5105, - "name": "jwt_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5103, - "name": "redis_options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/ioredis/built/redis/RedisOptions.d.ts", - "qualifiedName": "RedisOptions" - }, - "name": "RedisOptions", - "package": "ioredis" - } - }, - { - "id": 5102, - "name": "redis_prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5101, - "name": "redis_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5104, - "name": "session_options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 5204, - "name": "SessionOptions", - "package": "@medusajs/types" - } - }, - { - "id": 5118, - "name": "store_cors", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5119, - 5106, - 5108, - 5113, - 5110, - 5109, - 5111, - 5107, - 5112, - 5105, - 5103, - 5102, - 5101, - 5104, - 5118 - ] - } - ] - } - } - }, - { - "id": 5067, - "name": "ProviderLineItemTaxLine", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax line properties for a given line item." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 5068, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5071, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5072, - "name": "item_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5073, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 5070, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5069, - "name": "rate", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5071, - 5072, - 5073, - 5070, - 5069 - ] - } - ] - } - } - }, - { - "id": 5074, - "name": "ProviderShippingMethodTaxLine", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax line properties for a given shipping method." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 5075, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5078, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5079, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 5077, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5076, - "name": "rate", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 5080, - "name": "shipping_method_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5078, - 5079, - 5077, - 5076, - 5080 - ] - } - ] - } - } - }, - { - "id": 4924, - "name": "ProviderTaxLine", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A union type of the possible provider tax lines." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 5067, - "name": "ProviderLineItemTaxLine", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 5074, - "name": "ProviderShippingMethodTaxLine", - "package": "@medusajs/medusa" - } - ] - } - }, - { - "id": 3885, - "name": "QueryConfig", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 3893, - "name": "TEntity", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", - "qualifiedName": "BaseEntity" - }, - "name": "BaseEntity", - "package": "@medusajs/medusa" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 3886, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3889, - "name": "allowedFields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 3890, - "name": "allowedRelations", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 3887, - "name": "defaultFields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 3893, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - }, - { - "id": 3891, - "name": "defaultLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3888, - "name": "defaultRelations", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 3892, - "name": "isList", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3889, - 3890, - 3887, - 3891, - 3888, - 3892 - ] - } - ] - } - } - }, - { - "id": 3866, - "name": "QuerySelector", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 3869, - "name": "TEntity", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3874, - "typeArguments": [ - { - "type": "reference", - "target": 3869, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Selector", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 3867, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3868, - "name": "q", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3868 - ] - } - ] - } - } - ] - } - }, - { - "id": 4845, - "name": "RequestContext", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4846, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4847, - "name": "ip", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4847 - ] - } - ] - } - } - }, - { - "id": 4689, - "name": "ReservationItemDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents a reservation of an inventory item at a stock location" - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 4690, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4699, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was created." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 4697, - "name": "created_by", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "UserId of user who created the reservation item" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4701, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4696, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Description of the reservation item" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4691, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The id of the reservation item" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4693, - "name": "inventory_item_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The id of the inventory item the reservation relates to" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4695, - "name": "line_item_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4692, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The id of the location of the reservation" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4698, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional key-value map with additional details" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4694, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The id of the reservation item" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4700, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was updated." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4699, - 4697, - 4701, - 4696, - 4691, - 4693, - 4695, - 4692, - 4698, - 4694, - 4700 - ] - } - ] - } - } - }, - { - "id": 2097, - "name": "ResponseInventoryItem", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4386, - "name": "InventoryItemDTO", - "package": "@medusajs/types" - } - ], - "name": "Partial", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 2098, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2099, - "name": "location_levels", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The inventory's location levels." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2094, - "name": "LevelWithAvailability", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2099 - ] - } - ] - } - } - ] - } - }, - { - "id": 4889, - "name": "ReturnedData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4890, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4893, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4892, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4891, - "name": "to", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4893, - 4892, - 4891 - ] - } - ] - } - } - }, - { - "id": 5142, - "name": "RouteVerb", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "indexedAccess", - "indexType": { - "type": "intrinsic", - "name": "number" - }, - "objectType": { - "type": "query", - "queryType": { - "type": "reference", - "target": 5235, - "name": "HTTP_METHODS", - "package": "@medusajs/medusa" - } - } - } - }, - { - "id": 4167, - "name": "ScheduledJobArgs", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 4172, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 4168, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4169, - "name": "container", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 4878, - "name": "MedusaContainer", - "package": "@medusajs/types" - } - }, - { - "id": 4170, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 4172, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - { - "id": 4171, - "name": "pluginOptions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4169, - 4170, - 4171 - ] - } - ] - } - } - }, - { - "id": 4161, - "name": "ScheduledJobConfig", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 4166, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 4162, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4165, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional data object to pass to the job handler" - } - ] - }, - "type": { - "type": "reference", - "target": 4166, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - { - "id": 4163, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the job" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4164, - "name": "schedule", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The cron schedule of the job, e.g. " - }, - { - "kind": "code", - "text": "`0 0 * * *`" - }, - { - "kind": "text", - "text": " for running every day at midnight." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4165, - 4163, - 4164 - ] - } - ] - } - } - }, - { - "id": 3874, - "name": "Selector", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 3875, - "name": "TEntity", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 4952, - "typeArguments": [ - { - "type": "reference", - "target": 3875, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "InnerSelector", - "package": "@medusajs/medusa" - }, - { "type": "array", "elementType": { "type": "reference", - "target": 4952, - "typeArguments": [ - { - "type": "reference", - "target": 3875, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "InnerSelector", + "target": 4087, + "name": "AdminPriceListPricesUpdateReq", "package": "@medusajs/medusa" } } - ] - } - }, - { - "id": 5204, - "name": "SessionOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5205, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5206, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5207, - "name": "resave", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5208, - "name": "rolling", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5209, - "name": "saveUninitialized", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 5210, - "name": "secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5211, - "name": "ttl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5206, - 5207, - 5208, - 5209, - 5210, - 5211 - ] - } - ] - } - } - }, - { - "id": 4876, - "name": "ShippingMethodData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 4874, - "name": "ShippingOptionData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 5054, - "name": "ShippingOptionPricing", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 5055, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5056, - "name": "price_incl_tax", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Price including taxes" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5058, - "name": "tax_amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The taxes applied." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 5057, - "name": "tax_rates", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of applied tax rates" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 4910, - "name": "TaxServiceRate", - "package": "@medusajs/medusa" - } - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5056, - 5058, - 5057 - ] - } - ] - } - } - }, - { - "id": 3689, - "name": "ShippingTaxCalculationLine", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A shipping method and the tax rates that have been configured to apply to the\nshipping method." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3690, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3692, - "name": "rates", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4910, - "name": "TaxServiceRate", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 3691, - "name": "shipping_method", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", - "qualifiedName": "ShippingMethod" - }, - "name": "ShippingMethod", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3692, - 3691 - ] - } - ] - } - } - }, - { - "id": 5026, - "name": "StockLocationAddressDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents a Stock Location Address" - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 5027, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5029, - "name": "address_1", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5030, - "name": "address_2", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' complement" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5033, - "name": "city", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' city" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5031, - "name": "company", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location company' name" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5032, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' country" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5038, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was created." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 5040, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5028, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The stock location address' ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 5037, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional key-value map with additional details" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5034, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' phone number" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5035, - "name": "postal_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' postal code" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5036, - "name": "province", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' province" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5039, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was updated." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5029, - 5030, - 5033, - 5031, - 5032, - 5038, - 5040, - 5028, - 5037, - 5034, - 5035, - 5036, - 5039 - ] - } - ] - } - } - }, - { - "id": 4713, - "name": "StockLocationDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Represents a Stock Location" - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 4714, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4719, - "name": "address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The Address of the Stock Location" - } - ] - }, - "type": { - "type": "reference", - "target": 5026, - "name": "StockLocationAddressDTO", - "package": "@medusajs/types" - } - }, - { - "id": 4718, - "name": "address_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Stock location address' ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4720, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was created." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 4722, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4715, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The stock location's ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4717, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An optional key-value map with additional details" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4716, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the stock location" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4721, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The date with timezone at which the resource was updated." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4719, - 4718, - 4720, - 4722, - 4715, - 4717, - 4716, - 4721 - ] - } - ] - } - } - }, - { - "id": 4728, - "name": "StockLocationExpandedDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 4713, - "name": "StockLocationDTO", - "package": "@medusajs/types" - }, - { - "type": "reflection", - "declaration": { - "id": 4729, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4730, - "name": "sales_channels", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated sales channels." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4730 - ] - } - ] - } - } - ] - } - }, - { - "id": 2112, - "name": "StoreAuthRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2113, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2114, - "name": "customer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Customer's details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer.ts", - "qualifiedName": "Customer" - }, - "name": "Customer", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2114 - ] - } - ] - } - } - }, - { - "id": 2115, - "name": "StoreBearerAuthRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The access token details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2116, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2117, - "name": "access_token", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Access token that can be used to send authenticated requests." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2117 - ] - } - ] - } - } - }, - { - "id": 2569, - "name": "StoreCartShippingOptionsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2570, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2571, - "name": "shipping_options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of shipping options details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4800, - "name": "PricedShippingOption", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2571 - ] - } - ] - } - } - }, - { - "id": 2128, - "name": "StoreCartsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The cart's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2129, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2130, - "name": "cart", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Cart details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "refundable_amount" - }, - { - "type": "literal", - "value": "refunded_total" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2130 - ] - } - ] - } - } - }, - { - "id": 2193, - "name": "StoreCollectionsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of product collections with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 2194, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2195, - "name": "collections", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product collections details" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-collection.ts", - "qualifiedName": "ProductCollection" - }, - "name": "ProductCollection", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2195 - ] - } - ] - } - } - ] - } - }, - { - "id": 2196, - "name": "StoreCollectionsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the product collection." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2197, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2198, - "name": "collection", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product collection details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-collection.ts", - "qualifiedName": "ProductCollection" - }, - "name": "ProductCollection", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2198 - ] - } - ] - } - } - }, - { - "id": 2131, - "name": "StoreCompleteCartRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the cart is completed successfully, this will have the created order or the swap's details, based on the cart's type. Otherwise, it'll be the cart's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2132, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2134, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" - } - }, - { - "id": 2133, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "literal", - "value": "cart" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2134, - 2133 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2135, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2137, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "Order" - }, - "name": "Order", - "package": "@medusajs/medusa" - } - }, - { - "id": 2136, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "literal", - "value": "order" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2137, - 2136 - ] - } - ] - } - }, - { - "type": "reflection", - "declaration": { - "id": 2138, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2140, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A swap can be created when a Customer wishes to exchange Products that they have purchased with different Products. It consists of a Return of previously purchased Products and a Fulfillment of new Products. It also includes information on any additional payment or refund required based on the difference between the exchanged products." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/swap.ts", - "qualifiedName": "Swap" - }, - "name": "Swap", - "package": "@medusajs/medusa" - } - }, - { - "id": 2139, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "literal", - "value": "swap" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2140, - 2139 - ] - } - ] - } - } - ] - } - }, - { - "id": 2217, - "name": "StoreCustomersListOrdersRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of the customer's orders with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 2218, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2219, - "name": "orders", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of orders details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "Order" - }, - "name": "Order", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2219 - ] - } - ] - } - } - ] - } - }, - { - "id": 2220, - "name": "StoreCustomersListPaymentMethodsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The payment method's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2221, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2222, - "name": "payment_methods", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the saved payment methods." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 2223, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2225, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data needed for the Payment Provider to use the saved payment method." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 2224, - "name": "provider_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the Payment Provider where the payment method is saved." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2225, - 2224 - ] - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2222 - ] - } - ] - } - } - }, - { - "id": 2211, - "name": "StoreCustomersRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The customer's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2212, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2213, - "name": "customer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Customer details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer.ts", - "qualifiedName": "Customer" - }, - "name": "Customer", - "package": "@medusajs/medusa" - }, - { - "type": "literal", - "value": "password_hash" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2213 - ] - } - ] - } - } - }, - { - "id": 2214, - "name": "StoreCustomersResetPasswordRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2215, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2216, - "name": "customer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Customer details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer.ts", - "qualifiedName": "Customer" - }, - "name": "Customer", - "package": "@medusajs/medusa" - }, - { - "type": "literal", - "value": "password_hash" - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2216 - ] - } - ] - } - } - }, - { - "id": 2118, - "name": "StoreGetAuthEmailRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Details on whether the email exists." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2119, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2120, - "name": "exists", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether email exists or not." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2120 - ] - } - ] - } - } - }, - { - "id": 2378, - "name": "StoreGetProductCategoriesCategoryRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product category's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2379, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2380, - "name": "product_category", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product category details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", - "qualifiedName": "ProductCategory" - }, - "name": "ProductCategory", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2380 - ] - } - ] - } - } - }, - { - "id": 2381, - "name": "StoreGetProductCategoriesRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of product categories with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 2382, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2383, - "name": "product_categories", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product categories details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", - "qualifiedName": "ProductCategory" - }, - "name": "ProductCategory", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2383 - ] - } - ] - } - } - ] - } - }, - { - "id": 2304, - "name": "StoreGiftCardsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The gift card's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2305, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2306, - "name": "gift_card", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Gift card details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/gift-card.ts", - "qualifiedName": "GiftCard" - }, - "name": "GiftCard", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2306 - ] - } - ] - } - } - }, - { - "id": 2307, - "name": "StoreOrderEditsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The order edit's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2308, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2309, - "name": "order_edit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Order edit details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order-edit.ts", - "qualifiedName": "OrderEdit" - }, - "name": "OrderEdit", - "package": "@medusajs/medusa" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "internal_note" - }, - { - "type": "literal", - "value": "created_by" - }, - { - "type": "literal", - "value": "confirmed_by" - }, - { - "type": "literal", - "value": "canceled_by" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2309 - ] - } - ] - } - } - }, - { - "id": 2318, - "name": "StoreOrdersRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The order's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2319, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2320, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Order details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "Order" - }, - "name": "Order", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2320 - ] - } - ] - } - } - }, - { - "id": 2342, - "name": "StorePaymentCollectionsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The payment collection's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2343, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2344, - "name": "payment_collection", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payment collection's details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-collection.ts", - "qualifiedName": "PaymentCollection" - }, - "name": "PaymentCollection", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2344 - ] - } - ] - } - } - }, - { - "id": 2345, - "name": "StorePaymentCollectionsSessionRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the payment session." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2346, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2347, - "name": "payment_session", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Payment session's details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", - "qualifiedName": "PaymentSession" - }, - "name": "PaymentSession", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2347 - ] - } - ] - } - } - }, - { - "id": 2477, - "name": "StorePostSearchRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of search results." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 2478, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2479, - "name": "hits", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Array of search results. The format of the items depends on the search engine installed on the Medusa backend." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2479 - ] - } - ] - } - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - }, - { - "id": 2404, - "name": "StoreProductTagsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of product tags with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 2405, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2406, - "name": "product_tags", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product tags details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-tag.ts", - "qualifiedName": "ProductTag" - }, - "name": "ProductTag", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2406 - ] - } - ] - } - } - ] - } - }, - { - "id": 2422, - "name": "StoreProductTypesListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 2423, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2424, - "name": "product_types", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product types details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-type.ts", - "qualifiedName": "ProductType" - }, - "name": "ProductType", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2424 - ] - } - ] - } - } - ] - } - }, - { - "id": 2480, - "name": "StoreProductsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of products with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3900, - "name": "PaginatedResponse", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 2481, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2482, - "name": "products", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of products details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4562, - "name": "PricedProduct", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2482 - ] - } - ] - } - } - ] - } - }, - { - "id": 2474, - "name": "StoreProductsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2475, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2476, - "name": "product", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product details." - } - ] - }, - "type": { - "type": "reference", - "target": 4562, - "name": "PricedProduct", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2476 - ] - } - ] - } - } - }, - { - "id": 2528, - "name": "StoreRegionsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of regions with pagination fields." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 4418, - "name": "PaginatedResponse", - "package": "@medusajs/types" - }, - { - "type": "reflection", - "declaration": { - "id": 2529, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2530, - "name": "regions", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of regions details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/region.ts", - "qualifiedName": "Region" - }, - "name": "Region", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2530 - ] - } - ] - } - } - ] - } - }, - { - "id": 2531, - "name": "StoreRegionsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The region's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2532, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2533, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Region details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/region.ts", - "qualifiedName": "Region" - }, - "name": "Region", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2533 - ] - } - ] - } - } - }, - { - "id": 2551, - "name": "StoreReturnReasonsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of return reasons." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2552, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2553, - "name": "return_reasons", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of return reasons details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/return-reason.ts", - "qualifiedName": "ReturnReason" - }, - "name": "ReturnReason", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2553 - ] - } - ] - } - } - }, - { - "id": 2554, - "name": "StoreReturnReasonsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The return reason's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2555, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2556, - "name": "return_reason", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return reason details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/return-reason.ts", - "qualifiedName": "ReturnReason" - }, - "name": "ReturnReason", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2556 - ] - } - ] - } - } - }, - { - "id": 2557, - "name": "StoreReturnsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The return's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2558, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2559, - "name": "return", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/return.ts", - "qualifiedName": "Return" - }, - "name": "Return", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2559 - ] - } - ] - } - } - }, - { - "id": 2566, - "name": "StoreShippingOptionsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of shipping options." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2567, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2568, - "name": "shipping_options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of shipping options details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4800, - "name": "PricedShippingOption", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2568 - ] - } - ] - } - } - }, - { - "id": 2580, - "name": "StoreSwapsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The swap's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2581, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2582, - "name": "swap", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Swap details." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/swap.ts", - "qualifiedName": "Swap" - }, - "name": "Swap", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2582 - ] - } - ] - } - } - }, - { - "id": 2595, - "name": "StoreVariantsListRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of product variants." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2596, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2597, - "name": "variants", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of product variant descriptions." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4763, - "name": "PricedVariant", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2597 - ] - } - ] - } - } - }, - { - "id": 2592, - "name": "StoreVariantsRes", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The product variant's details." - } - ], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2593, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2594, - "name": "variant", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Product variant description." - } - ] - }, - "type": { - "type": "reference", - "target": 4763, - "name": "PricedVariant", - "package": "@medusajs/medusa" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2594 - ] - } - ] - } - } - }, - { - "id": 4177, - "name": "SubscriberArgs", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 4183, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 4178, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4181, - "name": "container", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 4878, - "name": "MedusaContainer", - "package": "@medusajs/types" - } - }, - { - "id": 4179, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 4183, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - { - "id": 4180, - "name": "eventName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4182, - "name": "pluginOptions", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4181, - 4179, - 4180, - 4182 - ] - } - ] - } - } - }, - { - "id": 4173, - "name": "SubscriberConfig", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4174, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4176, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 4974, - "name": "SubscriberContext", - "package": "@medusajs/medusa" - } - }, - { - "id": 4175, - "name": "event", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4176, - 4175 - ] - } - ] - } - } - }, - { - "id": 3697, - "name": "TaxCalculationContext", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Information relevant to a tax calculation, such as the shipping address where\nthe items are going." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 3698, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3704, - "name": "allocation_map", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 4917, - "name": "LineAllocationsMap", - "package": "@medusajs/medusa" - } - }, - { - "id": 3700, - "name": "customer", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A customer can make purchases in your store and manage their profile." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/customer.ts", - "qualifiedName": "Customer" - }, - "name": "Customer", - "package": "@medusajs/medusa" - } - }, - { - "id": 3702, - "name": "is_return", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 3701, - "name": "region", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/region.ts", - "qualifiedName": "Region" - }, - "name": "Region", - "package": "@medusajs/medusa" - } - }, - { - "id": 3699, - "name": "shipping_address", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/address.ts", - "qualifiedName": "Address" - }, - "name": "Address", - "package": "@medusajs/medusa" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 3703, - "name": "shipping_methods", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", - "qualifiedName": "ShippingMethod" - }, - "name": "ShippingMethod", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3704, - 3700, - 3702, - 3701, - 3699, - 3703 - ] - } - ] - } - } - }, - { - "id": 4910, - "name": "TaxServiceRate", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax rate object as configured in Medusa. These may have an unspecified\nnumerical rate as they may be used for lookup purposes in the tax provider\nplugin." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 4911, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4914, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax rate's code." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 4913, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax rate's name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4912, - "name": "rate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax rate." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4914, - 4913, - 4912 - ] - } - ] - } - } - }, - { - "id": 5184, - "name": "TaxedPricing", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Pricing fields related to taxes." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 5185, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 5187, - "name": "calculated_price_incl_tax", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price after applying the tax amount on the calculated price." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5189, - "name": "calculated_tax", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax amount applied to the calculated price." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5186, - "name": "original_price_incl_tax", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price after applying the tax amount on the original price." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5188, - "name": "original_tax", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The tax amount applied to the original price." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 5190, - "name": "tax_rates", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of tax rates." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 4910, - "name": "TaxServiceRate", - "package": "@medusajs/medusa" - } - }, - { - "type": "literal", - "value": null - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 5187, - 5189, - 5186, - 5188, - 5190 - ] - } - ] - } - } - }, - { - "id": 3876, - "name": "TotalField", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "shipping_total" - }, - { - "type": "literal", - "value": "discount_total" - }, - { - "type": "literal", - "value": "tax_total" - }, - { - "type": "literal", - "value": "refunded_total" - }, - { - "type": "literal", - "value": "total" - }, - { - "type": "literal", - "value": "subtotal" - }, - { - "type": "literal", - "value": "refundable_amount" - }, - { - "type": "literal", - "value": "gift_card_total" - }, - { - "type": "literal", - "value": "gift_card_tax_total" - } - ] - } - }, - { - "id": 3870, - "name": "TreeQuerySelector", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 3873, - "name": "TEntity", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3866, - "typeArguments": [ - { - "type": "reference", - "target": 3873, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "QuerySelector", - "package": "@medusajs/medusa" - }, - { - "type": "reflection", - "declaration": { - "id": 3871, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3872, - "name": "include_descendants_tree", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3872 - ] - } - ] - } - } - ] - } - }, - { - "id": 4112, - "name": "UpdatePriceListInput", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Pick" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/price-list.ts", - "qualifiedName": "PriceList" - }, - "name": "PriceList", - "package": "@medusajs/medusa" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "name" - }, - { - "type": "literal", - "value": "description" - }, - { - "type": "literal", - "value": "starts_at" - }, - { - "type": "literal", - "value": "ends_at" - }, - { - "type": "literal", - "value": "status" - }, - { - "type": "literal", - "value": "type" - }, - { - "type": "literal", - "value": "includes_tax" - } - ] - } - ], - "name": "Pick", - "package": "typescript" - } - ], - "name": "Partial", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 4113, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4115, - "name": "customer_groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 4116, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4117, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4117 - ] - } - ] - } - } - } - }, - { - "id": 4114, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 4080, - "name": "AdminPriceListPricesUpdateReq", - "package": "@medusajs/medusa" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4115, - 4114 - ] - } - ] - } - } - ] - } - }, - { - "id": 4853, - "name": "UploadStreamDescriptorType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4854, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4856, - "name": "ext", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4857, - "name": "isPrivate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4855, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4856, - 4857, - 4855 - ] - } - ], - "indexSignature": { - "id": 4858, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 4859, - "name": "x", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - } - } - }, - { - "id": 2100, - "name": "VariantInventory", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [], - "modifierTags": [ - "@interface" - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2101, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2102, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the ID of the variant" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2103, - "name": "inventory", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The inventory details." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 2097, - "name": "ResponseInventoryItem", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 2104, - "name": "sales_channel_availability", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Details about the variant's inventory availability in sales channels." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 2105, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2108, - "name": "available_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Available quantity in the sales channel" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 2107, - "name": "channel_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sales channel's ID" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2106, - "name": "channel_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Sales channel's name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2108, - 2107, - 2106 - ] - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2102, - 2103, - 2104 - ] - } - ] - } - } - }, - { - "id": 3839, - "name": "WithRequiredProperty", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Utility type used to remove some optional attributes (coming from K) from a type T" - } - ] - }, - "typeParameters": [ - { - "id": 3840, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} }, { - "id": 3841, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": {}, + "id": 1086, + "name": "override", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, the prices will replace all existing prices associated with the Price List." + } + ] + }, "type": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 3840, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } + "type": "intrinsic", + "name": "boolean" } } ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3840, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - { - "type": "mapped", - "parameter": "Property", - "parameterType": { - "type": "reference", - "target": 3841, - "name": "K", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "Property" - }, - "name": "Property", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 3840, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - "optionalModifier": "-" - } - ] - } - }, - { - "id": 3845, - "name": "Writable", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ + "groups": [ { - "id": 3846, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "mapped", - "parameter": "key", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 3846, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "union", - "types": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "key" - }, - "name": "key", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 3846, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", - "qualifiedName": "FindOperator" - }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "key" - }, - "name": "key", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 3846, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "name": "FindOperator", - "package": "typeorm" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", - "qualifiedName": "FindOperator" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "key" - }, - "name": "key", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 3846, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - } - ], - "name": "FindOperator", - "package": "typeorm" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", - "qualifiedName": "FindOperator" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ], - "name": "FindOperator", - "package": "typeorm" - } + "title": "Constructors", + "children": [ + 1083 ] }, - "readonlyModifier": "-" - } + { + "title": "Properties", + "children": [ + 1085, + 1086 + ] + } + ] }, { - "id": 4840, - "name": "handler", + "id": 4549, + "name": "CustomerGroup", "variant": "declaration", - "kind": 2097152, + "kind": 128, "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4841, - "name": "__type", + "comment": { + "summary": [ + { + "kind": "text", + "text": "A customer group that can be used to organize customers into groups of similar traits." + } + ] + }, + "children": [ + { + "id": 4550, + "name": "constructor", "variant": "declaration", - "kind": 65536, + "kind": 512, "flags": {}, "signatures": [ { - "id": 4842, - "name": "__type", + "id": 4551, + "name": "new CustomerGroup", "variant": "signature", - "kind": 4096, + "kind": 16384, "flags": {}, - "parameters": [ - { - "id": 4843, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Request" - }, - "name": "Request", - "package": "@types/express", - "qualifiedName": "e.Request" + "comment": { + "summary": [ + { + "kind": "text", + "text": "A customer group that can be used to organize customers into groups of similar traits." } - }, - { - "id": 4844, - "name": "res", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Response" - }, - "name": "Response", - "package": "@types/express", - "qualifiedName": "e.Response" - } - } - ], + ] + }, "type": { "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" + "target": 4549, + "name": "CustomerGroup", + "package": "@medusajs/medusa" } } ] + }, + { + "id": 4552, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a customer group" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } } - } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4550 + ] + }, + { + "title": "Properties", + "children": [ + 4552 + ] + } + ] }, { - "id": 2035, - "name": "payload", + "id": 1087, + "name": "AdminPostPriceListsPriceListReq", "variant": "declaration", - "kind": 2097152, + "kind": 128, "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2036, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2037, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2039, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 2038, - "name": "user_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2037, - 2039, - 2038 - ] - } - ] - } - } - }, - { - "id": 733, - "name": "AvailableOrderIncludes", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 734, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 735, - "name": "RETURNABLE_ITEMS", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "defaultValue": "\"returnable_items\"" - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 735 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 5235, - "name": "HTTP_METHODS", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, "comment": { "summary": [ { "kind": "text", - "text": "List of all the supported HTTP methods" + "text": "The details of the price list to create." } ] }, - "type": { - "type": "typeOperator", - "operator": "readonly", - "target": { - "type": "tuple", - "elements": [ - { - "type": "literal", - "value": "GET" - }, - { - "type": "literal", - "value": "POST" - }, - { - "type": "literal", - "value": "PUT" - }, - { - "type": "literal", - "value": "PATCH" - }, - { - "type": "literal", - "value": "DELETE" - }, - { - "type": "literal", - "value": "OPTIONS" - }, - { - "type": "literal", - "value": "HEAD" - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 3623, - "name": "PriceType", - "variant": "declaration", - "kind": 32, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3624, - "name": "__type", + "children": [ + { + "id": 1088, + "name": "constructor", "variant": "declaration", - "kind": 65536, + "kind": 512, "flags": {}, - "children": [ + "signatures": [ { - "id": 3627, - "name": "DEFAULT", - "variant": "declaration", - "kind": 1024, + "id": 1089, + "name": "new AdminPostPriceListsPriceListReq", + "variant": "signature", + "kind": 16384, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the price list to create." + } + ] + }, "type": { "type": "reference", - "target": 4915, - "name": "DEFAULT", - "package": "@medusajs/medusa", - "qualifiedName": "DefaultPriceType.DEFAULT" - }, - "defaultValue": "\"default\"" - }, - { - "id": 3626, - "name": "OVERRIDE", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 4063, - "name": "OVERRIDE", - "package": "@medusajs/medusa", - "qualifiedName": "PriceListType.OVERRIDE" - }, - "defaultValue": "\"override\"" - }, - { - "id": 3625, - "name": "SALE", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 4062, - "name": "SALE", - "package": "@medusajs/medusa", - "qualifiedName": "PriceListType.SALE" - }, - "defaultValue": "\"sale\"" - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3627, - 3626, - 3625 - ] + "target": 1087, + "name": "AdminPostPriceListsPriceListReq", + "package": "@medusajs/medusa" + } } ] - } - } - }, - { - "id": 1159, - "name": "allowedAdminProductCategoryRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2192, - "name": "allowedFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 736, - "name": "allowedOrderIncludes", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2210, - "name": "allowedStoreCustomersFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2209, - "name": "allowedStoreCustomersRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2303, - "name": "allowedStoreGiftCardFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2302, - "name": "allowedStoreGiftCardRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2317, - "name": "allowedStoreOrdersFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2315, - "name": "allowedStoreOrdersRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2377, - "name": "allowedStoreProductCategoryFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2402, - "name": "allowedStoreProductTagFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2419, - "name": "allowedStoreProductTypeFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2439, - "name": "allowedStoreProductsFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2440, - "name": "allowedStoreProductsRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2591, - "name": "allowedStoreVariantRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 997, - "name": "defaulPaymentCollectionRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 32, - "name": "defaultAdminBatchFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 64, - "name": "defaultAdminCollectionsFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 65, - "name": "defaultAdminCollectionsRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 140, - "name": "defaultAdminCustomerGroupsRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "never" - } - }, - "defaultValue": "[]" - }, - { - "id": 183, - "name": "defaultAdminCustomersRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 214, - "name": "defaultAdminDiscountConditionFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "typeOperator", - "operator": "keyof", - "target": { + }, + { + "id": 1090, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Price List." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1091, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the Price List." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1092, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone that the Price List starts being valid." + } + ] + }, + "type": { "type": "reference", "target": { - "sourceFileName": "../../../packages/medusa/src/models/discount-condition.ts", - "qualifiedName": "DiscountCondition" + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" }, - "name": "DiscountCondition", - "package": "@medusajs/medusa" + "name": "Date", + "package": "typescript" } - } - }, - "defaultValue": "..." - }, - { - "id": 215, - "name": "defaultAdminDiscountConditionRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 212, - "name": "defaultAdminDiscountsFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "typeOperator", - "operator": "keyof", - "target": { + }, + { + "id": 1093, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone that the Price List ends being valid." + } + ] + }, + "type": { "type": "reference", "target": { - "sourceFileName": "../../../packages/medusa/src/models/discount.ts", - "qualifiedName": "Discount" + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" }, - "name": "Discount", - "package": "@medusajs/medusa" + "name": "Date", + "package": "typescript" } - } - }, - "defaultValue": "..." - }, - { - "id": 213, - "name": "defaultAdminDiscountsRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 388, - "name": "defaultAdminDraftOrdersCartFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "typeOperator", - "operator": "keyof", - "target": { + }, + { + "id": 1094, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The status of the Price List. If the status is set to `draft`, the prices created in the price list will not be available of the customer." + } + ] + }, + "type": { "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/cart.ts", - "qualifiedName": "Cart" - }, - "name": "Cart", - "package": "@medusajs/medusa" + "target": 4543, + "name": "PriceListStatus", + "package": "@medusajs/utils" } - } - }, - "defaultValue": "..." - }, - { - "id": 387, - "name": "defaultAdminDraftOrdersCartRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 389, - "name": "defaultAdminDraftOrdersFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "typeOperator", - "operator": "keyof", - "target": { + }, + { + "id": 1095, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the Price List." + } + ] + }, + "type": { "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/draft-order.ts", - "qualifiedName": "DraftOrder" - }, - "name": "DraftOrder", - "package": "@medusajs/medusa" + "target": 4546, + "name": "PriceListType", + "package": "@medusajs/utils" + } + }, + { + "id": 1096, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prices of the Price List." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4097, + "name": "AdminPriceListPricesCreateReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1097, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of customer groups that the Price List applies to." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4549, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1098, + "name": "includes_tax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tax included in prices of price list" + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "tax_inclusive_pricing", + "tag": "@featureFlag" + } + ] + }, + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "tax_inclusive_pricing", + "tag": "@featureFlag" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" } } - }, - "defaultValue": "..." - }, - { - "id": 386, - "name": "defaultAdminDraftOrdersRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1088 + ] + }, + { + "title": "Properties", + "children": [ + 1090, + 1091, + 1092, + 1093, + 1094, + 1095, + 1096, + 1097, + 1098 + ] } - }, - "defaultValue": "..." + ] }, { - "id": 1277, - "name": "defaultAdminGetProductsVariantsFields", + "id": 1099, + "name": "AdminDeletePriceListPricesPricesReq", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the prices to delete." + } + ] }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 453, - "name": "defaultAdminGiftCardFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/gift-card.ts", - "qualifiedName": "GiftCard" - }, - "name": "GiftCard", - "package": "@medusajs/medusa" + "children": [ + { + "id": 1100, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1101, + "name": "new AdminDeletePriceListPricesPricesReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the prices to delete." + } + ] + }, + "type": { + "type": "reference", + "target": 1099, + "name": "AdminDeletePriceListPricesPricesReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1102, + "name": "price_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the prices to delete." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } } } - }, - "defaultValue": "..." - }, - { - "id": 454, - "name": "defaultAdminGiftCardRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1100 + ] + }, + { + "title": "Properties", + "children": [ + 1102 + ] } - }, - "defaultValue": "..." + ] }, { - "id": 484, - "name": "defaultAdminInventoryItemFields", + "id": 1103, + "name": "AdminDeletePriceListsPriceListProductsPricesBatchReq", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products' prices to delete." + } + ] }, - "type": { - "type": "array", - "elementType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4386, - "name": "InventoryItemDTO", - "package": "@medusajs/types" + "children": [ + { + "id": 1104, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1105, + "name": "new AdminDeletePriceListsPriceListProductsPricesBatchReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products' prices to delete." + } + ] + }, + "type": { + "type": "reference", + "target": 1103, + "name": "AdminDeletePriceListsPriceListProductsPricesBatchReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1106, + "name": "product_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the products to delete their associated prices." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } } } - }, - "defaultValue": "..." - }, - { - "id": 486, - "name": "defaultAdminInventoryItemRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "never" + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1104 + ] + }, + { + "title": "Properties", + "children": [ + 1106 + ] } - }, - "defaultValue": "[]" - }, - { - "id": 485, - "name": "defaultAdminLocationLevelFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 4406, - "name": "InventoryLevelDTO", - "package": "@medusajs/types" - } - } - }, - "defaultValue": "..." - }, - { - "id": 652, - "name": "defaultAdminNotificationsFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 651, - "name": "defaultAdminNotificationsRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 1063, - "name": "defaultAdminPriceListFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 1064, - "name": "defaultAdminPriceListRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." + ] }, { "id": 1034, @@ -112770,6 +30246,2863 @@ }, "defaultValue": "..." }, + { + "id": 1063, + "name": "defaultAdminPriceListFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 1064, + "name": "defaultAdminPriceListRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 1065, + "name": "AdminPriceListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1066, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1067, + "name": "price_list", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Price List details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/price-list.ts", + "qualifiedName": "PriceList" + }, + "name": "PriceList", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1067 + ] + } + ] + } + } + }, + { + "id": 1068, + "name": "AdminPriceListDeleteBatchRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of deleting a price list." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1069, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1070, + "name": "ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the deleted prices." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1071, + "name": "deleted", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether or not the items were deleted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": true + }, + { + "id": 1072, + "name": "object", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the object that was deleted. A price is also named `money-amount`." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "money-amount" + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1070, + 1071, + 1072 + ] + } + ] + } + } + }, + { + "id": 1073, + "name": "AdminPriceListDeleteProductPricesRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 1068, + "name": "AdminPriceListDeleteBatchRes", + "package": "@medusajs/medusa" + } + }, + { + "id": 1074, + "name": "AdminPriceListDeleteVariantPricesRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 1068, + "name": "AdminPriceListDeleteBatchRes", + "package": "@medusajs/medusa" + } + }, + { + "id": 1075, + "name": "AdminPriceListDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 1076, + "name": "AdminPriceListsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of price lists with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1077, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1078, + "name": "price_lists", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of price lists details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/price-list.ts", + "qualifiedName": "PriceList" + }, + "name": "PriceList", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1078 + ] + } + ] + } + } + ] + } + }, + { + "id": 1079, + "name": "AdminPriceListsProductsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of products with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1080, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1081, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of products details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1081 + ] + } + ] + } + } + ] + } + }, + { + "id": 1107, + "name": "AdminGetPriceListsPriceListProductsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved products associated with a price list." + } + ] + }, + "children": [ + { + "id": 1111, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1112, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search products' title, description, product variant's title and sku, and product collection's title." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1113, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statuses to filter products by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "ProductStatus" + }, + "name": "ProductStatus", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1114, + "name": "collection_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated collection ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1115, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tags to filter products by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1116, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Title to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1117, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1118, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Handle to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1119, + "name": "is_giftcard", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by whether they're gift cards." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1120, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Type to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1121, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1122, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the products' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1123, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the products' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1124, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the products' " + }, + { + "kind": "code", + "text": "`deleted_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1125, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin(\n { limit: 50 }\n).expand" + } + }, + { + "id": 1126, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin(\n { limit: 50 }\n).fields" + } + }, + { + "id": 1127, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin(\n { limit: 50 }\n).offset" + } + }, + { + "id": 1128, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of products returned in the list. Default is " + }, + { + "kind": "code", + "text": "`50`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin(\n { limit: 50 }\n).limit" + } + }, + { + "id": 1108, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1109, + "name": "new AdminGetPriceListsPriceListProductsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 1110, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 1107, + "name": "AdminGetPriceListsPriceListProductsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin(\n { limit: 50 }\n).constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin(\n { limit: 50 }\n).constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1108 + ] + }, + { + "title": "Properties", + "children": [ + 1111, + 1112, + 1113, + 1114, + 1115, + 1116, + 1117, + 1118, + 1119, + 1120, + 1121, + 1122, + 1123, + 1124, + 1125, + 1126, + 1127, + 1128 + ] + } + ], + "extendedTypes": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ] + }, + { + "id": 1129, + "name": "AdminGetPriceListPaginationParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved price lists." + } + ] + }, + "children": [ + { + "id": 1130, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1131, + "name": "new AdminGetPriceListPaginationParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1129, + "name": "AdminGetPriceListPaginationParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4076, + "name": "FilterablePriceListProps.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4075, + "name": "FilterablePriceListProps.constructor" + } + }, + { + "id": 1132, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 1133, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n10\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "10" + }, + { + "id": 1134, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1135, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1136, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter price lists by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4077, + "name": "FilterablePriceListProps.id" + } + }, + { + "id": 1137, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search terms to search price lists' description, name, and customer group's name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4078, + "name": "FilterablePriceListProps.q" + } + }, + { + "id": 1138, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statuses to filter price lists by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4071, + "name": "PriceListStatus", + "package": "@medusajs/medusa" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4079, + "name": "FilterablePriceListProps.status" + } + }, + { + "id": 1139, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name to filter price lists by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4080, + "name": "FilterablePriceListProps.name" + } + }, + { + "id": 1140, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter price lists by their associated customer groups." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4081, + "name": "FilterablePriceListProps.customer_groups" + } + }, + { + "id": 1141, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description to filter price lists by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4082, + "name": "FilterablePriceListProps.description" + } + }, + { + "id": 1142, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Types to filter price lists by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4068, + "name": "PriceListType", + "package": "@medusajs/medusa" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4083, + "name": "FilterablePriceListProps.type" + } + }, + { + "id": 1143, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the price lists' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4084, + "name": "FilterablePriceListProps.created_at" + } + }, + { + "id": 1144, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the price lists' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4085, + "name": "FilterablePriceListProps.updated_at" + } + }, + { + "id": 1145, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the price lists' " + }, + { + "kind": "code", + "text": "`deleted_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4086, + "name": "FilterablePriceListProps.deleted_at" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1130 + ] + }, + { + "title": "Properties", + "children": [ + 1132, + 1133, + 1134, + 1135, + 1136, + 1137, + 1138, + 1139, + 1140, + 1141, + 1142, + 1143, + 1144, + 1145 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4074, + "name": "FilterablePriceListProps", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 4553, + "name": "CustomerGroup", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A customer group that can be used to organize customers into groups of similar traits." + } + ] + }, + "children": [ + { + "id": 4554, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4555, + "name": "new CustomerGroup", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A customer group that can be used to organize customers into groups of similar traits." + } + ] + }, + "type": { + "type": "reference", + "target": 4553, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4556, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a customer group" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4554 + ] + }, + { + "title": "Properties", + "children": [ + 4556 + ] + } + ] + }, + { + "id": 1146, + "name": "AdminPostPriceListsPriceListPriceListReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the payment collection." + } + ] + }, + "children": [ + { + "id": 1147, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1148, + "name": "new AdminPostPriceListsPriceListPriceListReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the payment collection." + } + ] + }, + "type": { + "type": "reference", + "target": 1146, + "name": "AdminPostPriceListsPriceListPriceListReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1149, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Price List" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1150, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the Price List." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1151, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone that the Price List starts being valid." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 1152, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone that the Price List ends being valid." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 1153, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The status of the Price List. If the status is set to `draft`, the prices created in the price list will not be available of the customer." + } + ] + }, + "type": { + "type": "reference", + "target": 4543, + "name": "PriceListStatus", + "package": "@medusajs/utils" + } + }, + { + "id": 1154, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the Price List." + } + ] + }, + "type": { + "type": "reference", + "target": 4546, + "name": "PriceListType", + "package": "@medusajs/utils" + } + }, + { + "id": 1155, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prices of the Price List." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4087, + "name": "AdminPriceListPricesUpdateReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1156, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of customer groups that the Price List applies to." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4553, + "name": "CustomerGroup", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1157, + "name": "includes_tax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tax included in prices of price list" + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "tax_inclusive_pricing", + "tag": "@featureFlag" + } + ] + }, + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "tax_inclusive_pricing", + "tag": "@featureFlag" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1147 + ] + }, + { + "title": "Properties", + "children": [ + 1149, + 1150, + 1151, + 1152, + 1153, + 1154, + 1155, + 1156, + 1157 + ] + } + ] + }, + { + "id": 1218, + "name": "AdminPostProductCategoriesCategoryProductsBatchReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to add to the product category." + } + ] + }, + "children": [ + { + "id": 1219, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1220, + "name": "new AdminPostProductCategoriesCategoryProductsBatchReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to add to the product category." + } + ] + }, + "type": { + "type": "reference", + "target": 1218, + "name": "AdminPostProductCategoriesCategoryProductsBatchReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1221, + "name": "product_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the products to add to the product category" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4565, + "name": "ProductBatchProductCategory", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1219 + ] + }, + { + "title": "Properties", + "children": [ + 1221 + ] + } + ] + }, + { + "id": 1222, + "name": "AdminPostProductCategoriesCategoryProductsBatchParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1223, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1224, + "name": "new AdminPostProductCategoriesCategoryProductsBatchParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1222, + "name": "AdminPostProductCategoriesCategoryProductsBatchParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 1225, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 1226, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1223 + ] + }, + { + "title": "Properties", + "children": [ + 1225, + 1226 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1187, + "name": "AdminPostProductCategoriesReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product category to create." + } + ] + }, + "children": [ + { + "id": 1188, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1189, + "name": "new AdminPostProductCategoriesReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product category to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1187, + "name": "AdminPostProductCategoriesReq", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4559, + "name": "AdminProductCategoriesReqBase.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4558, + "name": "AdminProductCategoriesReqBase.constructor" + } + }, + { + "id": 1190, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the product category" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1191, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1192, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the product category." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4560, + "name": "AdminProductCategoriesReqBase.description" + } + }, + { + "id": 1193, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The handle of the product category. If none is provided, the kebab-case version of the name will be used. This field can be used as a slug in URLs." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4561, + "name": "AdminProductCategoriesReqBase.handle" + } + }, + { + "id": 1194, + "name": "is_internal", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, the product category will only be available to admins." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 4562, + "name": "AdminProductCategoriesReqBase.is_internal" + } + }, + { + "id": 1195, + "name": "is_active", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `false`, the product category will not be available in the storefront." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 4563, + "name": "AdminProductCategoriesReqBase.is_active" + } + }, + { + "id": 1196, + "name": "parent_category_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the parent product category" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 4564, + "name": "AdminProductCategoriesReqBase.parent_category_id" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1188 + ] + }, + { + "title": "Properties", + "children": [ + 1190, + 1191, + 1192, + 1193, + 1194, + 1195, + 1196 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4557, + "name": "AdminProductCategoriesReqBase", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1197, + "name": "AdminPostProductCategoriesParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1198, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1199, + "name": "new AdminPostProductCategoriesParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1197, + "name": "AdminPostProductCategoriesParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 1200, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 1201, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1198 + ] + }, + { + "title": "Properties", + "children": [ + 1200, + 1201 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1227, + "name": "AdminDeleteProductCategoriesCategoryProductsBatchReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to delete from the product category." + } + ] + }, + "children": [ + { + "id": 1228, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1229, + "name": "new AdminDeleteProductCategoriesCategoryProductsBatchReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to delete from the product category." + } + ] + }, + "type": { + "type": "reference", + "target": 1227, + "name": "AdminDeleteProductCategoriesCategoryProductsBatchReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1230, + "name": "product_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the products to delete from the product category." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4565, + "name": "ProductBatchProductCategory", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1228 + ] + }, + { + "title": "Properties", + "children": [ + 1230 + ] + } + ] + }, + { + "id": 1231, + "name": "AdminDeleteProductCategoriesCategoryProductsBatchParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1232, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1233, + "name": "new AdminDeleteProductCategoriesCategoryProductsBatchParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1231, + "name": "AdminDeleteProductCategoriesCategoryProductsBatchParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 1234, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 1235, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1232 + ] + }, + { + "title": "Properties", + "children": [ + 1234, + 1235 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1168, + "name": "AdminGetProductCategoryParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1169, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1170, + "name": "new AdminGetProductCategoryParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1168, + "name": "AdminGetProductCategoryParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 1171, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 1172, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1169 + ] + }, + { + "title": "Properties", + "children": [ + 1171, + 1172 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, { "id": 1158, "name": "defaultAdminProductCategoryRelations", @@ -112787,6 +33120,4175 @@ }, "defaultValue": "..." }, + { + "id": 1159, + "name": "allowedAdminProductCategoryRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 1160, + "name": "defaultProductCategoryFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 1161, + "name": "AdminProductCategoriesCategoryRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product category's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1162, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1163, + "name": "product_category", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product category details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1163 + ] + } + ] + } + } + }, + { + "id": 1164, + "name": "AdminProductCategoriesCategoryDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 1165, + "name": "AdminProductCategoriesListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of product categories with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1166, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1167, + "name": "product_categories", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product category details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1167 + ] + } + ] + } + } + ] + } + }, + { + "id": 1173, + "name": "AdminGetProductCategoriesParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved product categories." + } + ] + }, + "children": [ + { + "id": 1177, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search product categories' names and handles." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1178, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Handle to filter product categories by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1179, + "name": "include_descendants_tree", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include child product categories in the response." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1180, + "name": "is_internal", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter product categories by whether they're internal." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1181, + "name": "is_active", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter product categories by whether they're active." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1182, + "name": "parent_category_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter product categories by their associated parent ID." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1183, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).expand" + } + }, + { + "id": 1184, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).fields" + } + }, + { + "id": 1185, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).offset" + } + }, + { + "id": 1186, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of product categories returned in the list. The default is " + }, + { + "kind": "code", + "text": "`100`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).limit" + } + }, + { + "id": 1174, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1175, + "name": "new AdminGetProductCategoriesParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 1176, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 1173, + "name": "AdminGetProductCategoriesParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1174 + ] + }, + { + "title": "Properties", + "children": [ + 1177, + 1178, + 1179, + 1180, + 1181, + 1182, + 1183, + 1184, + 1185, + 1186 + ] + } + ], + "extendedTypes": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ] + }, + { + "id": 1202, + "name": "AdminPostProductCategoriesCategoryReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the product category." + } + ] + }, + "children": [ + { + "id": 1203, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1204, + "name": "new AdminPostProductCategoriesCategoryReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the product category." + } + ] + }, + "type": { + "type": "reference", + "target": 1202, + "name": "AdminPostProductCategoriesCategoryReq", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4559, + "name": "AdminProductCategoriesReqBase.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4558, + "name": "AdminProductCategoriesReqBase.constructor" + } + }, + { + "id": 1205, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name to identify the Product Category by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1206, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A handle to be used in slugs." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "overwrites": { + "type": "reference", + "target": 4561, + "name": "AdminProductCategoriesReqBase.handle" + } + }, + { + "id": 1207, + "name": "rank", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rank of the category in the tree node (starting from 0)" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1208, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs to hold additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1209, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional text field to describe the Product Category by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4560, + "name": "AdminProductCategoriesReqBase.description" + } + }, + { + "id": 1210, + "name": "is_internal", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A flag to make product category an internal category for admins" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 4562, + "name": "AdminProductCategoriesReqBase.is_internal" + } + }, + { + "id": 1211, + "name": "is_active", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A flag to make product category visible/hidden in the store front" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 4563, + "name": "AdminProductCategoriesReqBase.is_active" + } + }, + { + "id": 1212, + "name": "parent_category_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the parent product category" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 4564, + "name": "AdminProductCategoriesReqBase.parent_category_id" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1203 + ] + }, + { + "title": "Properties", + "children": [ + 1205, + 1206, + 1207, + 1208, + 1209, + 1210, + 1211, + 1212 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4557, + "name": "AdminProductCategoriesReqBase", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1213, + "name": "AdminPostProductCategoriesCategoryParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1214, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1215, + "name": "new AdminPostProductCategoriesCategoryParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1213, + "name": "AdminPostProductCategoriesCategoryParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 1216, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 1217, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1214 + ] + }, + { + "title": "Properties", + "children": [ + 1216, + 1217 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1236, + "name": "defaultAdminProductTagsFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 1237, + "name": "defaultAdminProductTagsRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "never" + } + }, + "defaultValue": "[]" + }, + { + "id": 1238, + "name": "AdminProductTagsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of product tags with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1239, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1240, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product tag details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-tag.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1240 + ] + } + ] + } + } + ] + } + }, + { + "id": 1241, + "name": "AdminGetProductTagsPaginationParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how a list of data is paginated." + } + ] + }, + "children": [ + { + "id": 1242, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1243, + "name": "new AdminGetProductTagsPaginationParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1241, + "name": "AdminGetProductTagsPaginationParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1244, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n10\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "10" + }, + { + "id": 1245, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1242 + ] + }, + { + "title": "Properties", + "children": [ + 1244, + 1245 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 1246, + "name": "AdminGetProductTagsParams" + } + ] + }, + { + "id": 1246, + "name": "AdminGetProductTagsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved product tags." + } + ] + }, + "children": [ + { + "id": 1247, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1248, + "name": "new AdminGetProductTagsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1246, + "name": "AdminGetProductTagsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 1243, + "name": "AdminGetProductTagsPaginationParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 1242, + "name": "AdminGetProductTagsPaginationParams.constructor" + } + }, + { + "id": 1256, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n10\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "10", + "inheritedFrom": { + "type": "reference", + "target": 1244, + "name": "AdminGetProductTagsPaginationParams.limit" + } + }, + { + "id": 1257, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": 1245, + "name": "AdminGetProductTagsPaginationParams.offset" + } + }, + { + "id": 1249, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter product tags by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 1250, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search product tags' value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1251, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Values to search product tags by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 1252, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the product tags' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1253, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the product tags' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1254, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1255, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter product tags by their associated discount condition's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1247 + ] + }, + { + "title": "Properties", + "children": [ + 1256, + 1257, + 1249, + 1250, + 1251, + 1252, + 1253, + 1254, + 1255 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 1241, + "name": "AdminGetProductTagsPaginationParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1258, + "name": "defaultAdminProductTypeFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 1259, + "name": "defaultAdminProductTypeRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "never" + } + }, + "defaultValue": "[]" + }, + { + "id": 1260, + "name": "AdminProductTypesListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of product types with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1261, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1262, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product types details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-type.ts", + "qualifiedName": "ProductType" + }, + "name": "ProductType", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1262 + ] + } + ] + } + } + ] + } + }, + { + "id": 1263, + "name": "AdminGetProductTypesParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved product types." + } + ] + }, + "children": [ + { + "id": 1264, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1265, + "name": "new AdminGetProductTypesParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1263, + "name": "AdminGetProductTypesParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3977, + "name": "FindPaginationParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3976, + "name": "FindPaginationParams.constructor" + } + }, + { + "id": 1266, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter product types by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 1267, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search terms to search product types' value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1268, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Values to filter product types by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 1269, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the product types' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1270, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the product types' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1271, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1272, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter product types by their associated discount condition's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1273, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": 3978, + "name": "FindPaginationParams.offset" + } + }, + { + "id": 1274, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": 3979, + "name": "FindPaginationParams.limit" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1264 + ] + }, + { + "title": "Properties", + "children": [ + 1266, + 1267, + 1268, + 1269, + 1270, + 1271, + 1272, + 1273, + 1274 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3975, + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1348, + "name": "AdminPostProductsProductOptionsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product option to create." + } + ] + }, + "children": [ + { + "id": 1349, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1350, + "name": "new AdminPostProductsProductOptionsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product option to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1348, + "name": "AdminPostProductsProductOptionsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1351, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title the Product Option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1349 + ] + }, + { + "title": "Properties", + "children": [ + 1351 + ] + } + ] + }, + { + "id": 5005, + "name": "ProductVariantOptionReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 5006, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 5007, + "name": "new ProductVariantOptionReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 5005, + "name": "ProductVariantOptionReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 5008, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value to give for the Product Option at the same index in the Product's `options` field." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 5006 + ] + }, + { + "title": "Properties", + "children": [ + 5008 + ] + } + ] + }, + { + "id": 4590, + "name": "ProductOptionReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4591, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4592, + "name": "new ProductOptionReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4590, + "name": "ProductOptionReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4593, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Product Option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4591 + ] + }, + { + "title": "Properties", + "children": [ + 4593 + ] + } + ] + }, + { + "id": 4594, + "name": "ProductVariantReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4595, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4596, + "name": "new ProductVariantReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4594, + "name": "ProductVariantReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4597, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4598, + "name": "sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique SKU of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4599, + "name": "ean", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The EAN number of the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4600, + "name": "upc", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The UPC number of the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4601, + "name": "barcode", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A generic GTIN field of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4602, + "name": "hs_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Harmonized System code of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4603, + "name": "inventory_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of stock kept of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 4604, + "name": "allow_backorder", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Product Variant can be purchased when out of stock." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4605, + "name": "manage_inventory", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether Medusa should keep track of the inventory of this Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4606, + "name": "weight", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The wieght of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4607, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The length of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4608, + "name": "height", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4609, + "name": "width", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The width of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4610, + "name": "origin_country", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The country of origin of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4611, + "name": "mid_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Manufacturer Identification code of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4612, + "name": "material", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The material composition of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4613, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 4614, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product variant prices. A product variant can have different prices for each region or currency code." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4616, + "name": "ProductVariantPricesCreateReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 4615, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of Product Option values that the variant corresponds to. The option values should be added into the array in the same index as in the `options` field of the product." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5005, + "name": "ProductVariantOptionReq", + "package": "@medusajs/medusa" + } + }, + "defaultValue": "[]" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4595 + ] + }, + { + "title": "Properties", + "children": [ + 4597, + 4598, + 4599, + 4600, + 4601, + 4602, + 4603, + 4604, + 4605, + 4606, + 4607, + 4608, + 4609, + 4610, + 4611, + 4612, + 4613, + 4614, + 4615 + ] + } + ] + }, + { + "id": 1352, + "name": "AdminPostProductsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product to create." + } + ] + }, + "children": [ + { + "id": 1353, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1354, + "name": "new AdminPostProductsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1352, + "name": "AdminPostProductsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1355, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Product" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1356, + "name": "subtitle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The subtitle of the Product" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1357, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1358, + "name": "is_giftcard", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A flag to indicate if the Product represents a Gift Card. Purchasing Products with this flag set to `true` will result in a Gift Card being created." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 1359, + "name": "discountable", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A flag to indicate if discounts can be applied to the Line Items generated from this Product" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "true" + }, + { + "id": 1360, + "name": "images", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of images of the Product. Each value in the array is a URL to the image. You can use the upload API Routes to upload the image and obtain a URL." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1361, + "name": "thumbnail", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The thumbnail to use for the Product. The value is a URL to the thumbnail. You can use the upload API Routes to upload the thumbnail and obtain a URL." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1362, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique handle to identify the Product by. If not provided, the kebab-case version of the product title will be used. This can be used as a slug in URLs." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1363, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The status of the product. The product is shown to the customer only if its status is `published`." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "ProductStatus" + }, + "name": "ProductStatus", + "package": "@medusajs/medusa" + }, + "defaultValue": "ProductStatus.DRAFT" + }, + { + "id": 1364, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Product Type to associate the Product with." + } + ] + }, + "type": { + "type": "reference", + "target": 4572, + "name": "ProductTypeReq", + "package": "@medusajs/medusa" + } + }, + { + "id": 1365, + "name": "collection_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Product Collection the Product belongs to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1366, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product Tags to associate the Product with." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4577, + "name": "ProductTagReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1367, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sales channels to associate the Product with." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4582, + "name": "ProductSalesChannelReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1368, + "name": "categories", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product categories to add the Product to." + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "product_categories", + "tag": "@featureFlag" + } + ] + }, + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "product_categories", + "tag": "@featureFlag" + } + ] + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4586, + "name": "ProductProductCategoryReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1369, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Options that the Product should have. A new product option will be created for every item in the array." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4590, + "name": "ProductOptionReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1370, + "name": "variants", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of Product Variants to create with the Product. Each product variant must have a unique combination of Product Option values." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4594, + "name": "ProductVariantReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1371, + "name": "weight", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The weight of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1372, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The length of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1373, + "name": "height", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1374, + "name": "width", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The width of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1375, + "name": "hs_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Harmonized System code of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1376, + "name": "origin_country", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The country of origin of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1377, + "name": "mid_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Manufacturer Identification code of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1378, + "name": "material", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The material composition of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1379, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1353 + ] + }, + { + "title": "Properties", + "children": [ + 1355, + 1356, + 1357, + 1358, + 1359, + 1360, + 1361, + 1362, + 1363, + 1364, + 1365, + 1366, + 1367, + 1368, + 1369, + 1370, + 1371, + 1372, + 1373, + 1374, + 1375, + 1376, + 1377, + 1378, + 1379 + ] + } + ] + }, + { + "id": 4624, + "name": "ProductVariantOptionReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4625, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4626, + "name": "new ProductVariantOptionReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4624, + "name": "ProductVariantOptionReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4627, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A value to give to the Product Option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4628, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Product Option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4625 + ] + }, + { + "title": "Properties", + "children": [ + 4627, + 4628 + ] + } + ] + }, + { + "id": 1380, + "name": "AdminPostProductsProductVariantsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product variant to create." + } + ] + }, + "children": [ + { + "id": 1381, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1382, + "name": "new AdminPostProductsProductVariantsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product variant to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1380, + "name": "AdminPostProductsProductVariantsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1383, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1384, + "name": "sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique SKU of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1385, + "name": "ean", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The EAN number of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1386, + "name": "upc", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The UPC number of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1387, + "name": "barcode", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A generic GTIN field of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1388, + "name": "hs_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Harmonized System code of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1389, + "name": "inventory_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of stock kept of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 1390, + "name": "allow_backorder", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the product variant can be purchased when out of stock." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1391, + "name": "manage_inventory", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether Medusa should keep track of the inventory of this product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "true" + }, + { + "id": 1392, + "name": "weight", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The wieght of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1393, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The length of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1394, + "name": "height", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1395, + "name": "width", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The width of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1396, + "name": "origin_country", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The country of origin of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1397, + "name": "mid_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Manufacturer Identification code of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1398, + "name": "material", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The material composition of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1399, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1400, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product variant prices. A product variant can have different prices for each region or currency code." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4616, + "name": "ProductVariantPricesCreateReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1401, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of Product Option values that the variant corresponds to." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4624, + "name": "ProductVariantOptionReq", + "package": "@medusajs/medusa" + } + }, + "defaultValue": "[]" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1381 + ] + }, + { + "title": "Properties", + "children": [ + 1383, + 1384, + 1385, + 1386, + 1387, + 1388, + 1389, + 1390, + 1391, + 1392, + 1393, + 1394, + 1395, + 1396, + 1397, + 1398, + 1399, + 1400, + 1401 + ] + } + ] + }, + { + "id": 1402, + "name": "AdminGetProductParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1403, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1404, + "name": "new AdminGetProductParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1402, + "name": "AdminGetProductParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 1405, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 1406, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1403 + ] + }, + { + "title": "Properties", + "children": [ + 1405, + 1406 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1275, + "name": "defaultAdminProductRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, { "id": 1276, "name": "defaultAdminProductFields", @@ -112814,8 +37316,8 @@ "defaultValue": "..." }, { - "id": 1275, - "name": "defaultAdminProductRelations", + "id": 1277, + "name": "defaultAdminGetProductsVariantsFields", "variant": "declaration", "kind": 32, "flags": { @@ -112855,92 +37357,6 @@ "kind": 65536, "flags": {}, "children": [ - { - "id": 1293, - "name": "categories", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1294, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1295, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1295 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 1290, - "name": "collection", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1291, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1292, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1292 - ] - } - ] - } - }, - "defaultValue": "..." - }, { "id": 1280, "name": "fields", @@ -113008,6 +37424,178 @@ }, "defaultValue": "..." }, + { + "id": 1284, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1285, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1286, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1286 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 1287, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1288, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1289, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1289 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 1290, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1291, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1292, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1292 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 1293, + "name": "categories", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1294, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1295, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1295 + ] + } + ] + } + }, + "defaultValue": "..." + }, { "id": 1296, "name": "options", @@ -113095,178 +37683,6 @@ }, "defaultValue": "..." }, - { - "id": 1308, - "name": "profile", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1309, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1310, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1310 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 1311, - "name": "sales_channels", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1312, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1313, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1313 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 1284, - "name": "tags", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1285, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1286, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1286 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 1287, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1288, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1289, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1289 - ] - } - ] - } - }, - "defaultValue": "..." - }, { "id": 1302, "name": "variants", @@ -113353,22 +37769,108 @@ } }, "defaultValue": "..." + }, + { + "id": 1308, + "name": "profile", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1309, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1310, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1310 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 1311, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1312, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1313, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1313 + ] + } + ] + } + }, + "defaultValue": "..." } ], "groups": [ { "title": "Properties", "children": [ - 1293, - 1290, 1280, 1281, - 1296, - 1308, - 1311, 1284, 1287, - 1302 + 1290, + 1293, + 1296, + 1302, + 1308, + 1311 ] } ] @@ -113377,72 +37879,5016 @@ "defaultValue": "..." }, { - "id": 1236, - "name": "defaultAdminProductTagsFields", + "id": 1314, + "name": "AdminProductsDeleteOptionRes", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of deleting a product's option." + } + ], + "modifierTags": [ + "@interface" + ] }, "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" + "type": "reflection", + "declaration": { + "id": 1315, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1316, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the deleted Product Option" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1317, + "name": "object", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the object that was deleted." + } + ] + }, + "type": { + "type": "literal", + "value": "option" + }, + "defaultValue": "option" + }, + { + "id": 1318, + "name": "deleted", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether or not the items were deleted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": true + }, + { + "id": 1319, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1316, + 1317, + 1318, + 1319 + ] + } + ] } - }, - "defaultValue": "..." + } }, { - "id": 1237, - "name": "defaultAdminProductTagsRelations", + "id": 1320, + "name": "AdminProductsDeleteVariantRes", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of deleting a product's variant." + } + ], + "modifierTags": [ + "@interface" + ] }, "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "never" + "type": "reflection", + "declaration": { + "id": 1321, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1322, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the deleted Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1323, + "name": "object", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the object that was deleted." + } + ] + }, + "type": { + "type": "literal", + "value": "product-variant" + }, + "defaultValue": "product-variant" + }, + { + "id": 1324, + "name": "deleted", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether or not the items were deleted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": true + }, + { + "id": 1325, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1322, + 1323, + 1324, + 1325 + ] + } + ] } - }, - "defaultValue": "[]" + } }, { - "id": 1258, - "name": "defaultAdminProductTypeFields", + "id": 1326, + "name": "AdminProductsDeleteRes", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of deleting a product." + } + ], + "modifierTags": [ + "@interface" + ] }, "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" + "type": "reflection", + "declaration": { + "id": 1327, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1328, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the deleted Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1329, + "name": "object", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the object that was deleted." + } + ] + }, + "type": { + "type": "literal", + "value": "product" + }, + "defaultValue": "product" + }, + { + "id": 1330, + "name": "deleted", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether or not the items were deleted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": true + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1328, + 1329, + 1330 + ] + } + ] } - }, - "defaultValue": "..." + } }, { - "id": 1259, - "name": "defaultAdminProductTypeRelations", + "id": 1331, + "name": "AdminProductsListRes", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of products with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] }, "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "never" - } + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1332, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1333, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of products details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 4569, + "name": "PricedProduct", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1333 + ] + } + ] + } + } + ] + } + }, + { + "id": 1334, + "name": "AdminProductsListVariantsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] }, - "defaultValue": "[]" + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1335, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1336, + "name": "variants", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product variants details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-variant.ts", + "qualifiedName": "ProductVariant" + }, + "name": "ProductVariant", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1336 + ] + } + ] + } + } + ] + } + }, + { + "id": 1337, + "name": "AdminProductsListTypesRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1338, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1339, + "name": "types", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product types details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-type.ts", + "qualifiedName": "ProductType" + }, + "name": "ProductType", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1339 + ] + } + ] + } + } + }, + { + "id": 1340, + "name": "AdminProductsListTagsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The usage details of product tags." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1341, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1342, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product tags details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Pick" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-tag.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "id" + }, + { + "type": "literal", + "value": "value" + } + ] + } + ], + "name": "Pick", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 1343, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1344, + "name": "usage_count", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of products that use this tag." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1344 + ] + } + ] + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1342 + ] + } + ] + } + } + }, + { + "id": 1345, + "name": "AdminProductsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1346, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1347, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1347 + ] + } + ] + } + } + }, + { + "id": 1407, + "name": "AdminGetProductsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved products." + } + ] + }, + "children": [ + { + "id": 1408, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1409, + "name": "new AdminGetProductsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1407, + "name": "AdminGetProductsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4631, + "name": "FilterableProductProps.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4630, + "name": "FilterableProductProps.constructor" + } + }, + { + "id": 1410, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 1411, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n50\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "50" + }, + { + "id": 1412, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1413, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1414, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1415, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter products by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 4632, + "name": "FilterableProductProps.id" + } + }, + { + "id": 1416, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search products' title, description, variants' title and sku, and collections' title." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4633, + "name": "FilterableProductProps.q" + } + }, + { + "id": 1417, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statuses to filter products by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "ProductStatus" + }, + "name": "ProductStatus", + "package": "@medusajs/medusa" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4634, + "name": "FilterableProductProps.status" + } + }, + { + "id": 1418, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated price lists' ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4635, + "name": "FilterableProductProps.price_list_id" + } + }, + { + "id": 1419, + "name": "collection_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated product collection's ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4636, + "name": "FilterableProductProps.collection_id" + } + }, + { + "id": 1420, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated tags' value." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4637, + "name": "FilterableProductProps.tags" + } + }, + { + "id": 1421, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Title to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4638, + "name": "FilterableProductProps.title" + } + }, + { + "id": 1422, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4639, + "name": "FilterableProductProps.description" + } + }, + { + "id": 1423, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Handle to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4640, + "name": "FilterableProductProps.handle" + } + }, + { + "id": 1424, + "name": "is_giftcard", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by whether they're gift cards." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 4641, + "name": "FilterableProductProps.is_giftcard" + } + }, + { + "id": 1425, + "name": "type_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated product type's ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4642, + "name": "FilterableProductProps.type_id" + } + }, + { + "id": 1426, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated sales channels' ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4643, + "name": "FilterableProductProps.sales_channel_id" + } + }, + { + "id": 1427, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated discount condition's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4644, + "name": "FilterableProductProps.discount_condition_id" + } + }, + { + "id": 1428, + "name": "category_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated product category's ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 4645, + "name": "FilterableProductProps.category_id" + } + }, + { + "id": 1429, + "name": "include_category_children", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include product category children in the response." + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "text", + "text": "product_categories" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 4646, + "name": "FilterableProductProps.include_category_children" + } + }, + { + "id": 1430, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the products' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4647, + "name": "FilterableProductProps.created_at" + } + }, + { + "id": 1431, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the products' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4648, + "name": "FilterableProductProps.updated_at" + } + }, + { + "id": 1432, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the products' " + }, + { + "kind": "code", + "text": "`deleted_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4649, + "name": "FilterableProductProps.deleted_at" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1408 + ] + }, + { + "title": "Properties", + "children": [ + 1410, + 1411, + 1412, + 1413, + 1414, + 1415, + 1416, + 1417, + 1418, + 1419, + 1420, + 1421, + 1422, + 1423, + 1424, + 1425, + 1426, + 1427, + 1428, + 1429, + 1430, + 1431, + 1432 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4629, + "name": "FilterableProductProps", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1433, + "name": "AdminGetProductsVariantsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1434, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1435, + "name": "new AdminGetProductsVariantsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1433, + "name": "AdminGetProductsVariantsParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1436, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1437, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1438, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 1439, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "100" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1434 + ] + }, + { + "title": "Properties", + "children": [ + 1436, + 1437, + 1438, + 1439 + ] + } + ] + }, + { + "id": 1440, + "name": "AdminPostProductsProductMetadataReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1441, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1442, + "name": "new AdminPostProductsProductMetadataReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1440, + "name": "AdminPostProductsProductMetadataReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1443, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The metadata key" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1444, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The metadata value" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1441 + ] + }, + { + "title": "Properties", + "children": [ + 1443, + 1444 + ] + } + ] + }, + { + "id": 1445, + "name": "AdminPostProductsProductOptionsOption", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1446, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1447, + "name": "new AdminPostProductsProductOptionsOption", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1445, + "name": "AdminPostProductsProductOptionsOption", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1448, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Product Option" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1446 + ] + }, + { + "title": "Properties", + "children": [ + 1448 + ] + } + ] + }, + { + "id": 5009, + "name": "ProductVariantOptionReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 5010, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 5011, + "name": "new ProductVariantOptionReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 5009, + "name": "ProductVariantOptionReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 5012, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the Product Option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5013, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 5010 + ] + }, + { + "title": "Properties", + "children": [ + 5012, + 5013 + ] + } + ] + }, + { + "id": 4650, + "name": "ProductVariantReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4651, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4652, + "name": "new ProductVariantReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4650, + "name": "ProductVariantReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4653, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of an existing product variant. If provided, the details of the product variant will be updated. If not, a new product variant will be created." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4654, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4655, + "name": "sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique SKU of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4656, + "name": "ean", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The EAN number of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4657, + "name": "upc", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The UPC number of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4658, + "name": "barcode", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A generic GTIN field of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4659, + "name": "hs_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Harmonized System code of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4660, + "name": "inventory_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of stock kept of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4661, + "name": "allow_backorder", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the product variant can be purchased when out of stock." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4662, + "name": "manage_inventory", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether Medusa should keep track of the inventory of this product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4663, + "name": "weight", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The weight of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4664, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The length of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4665, + "name": "height", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4666, + "name": "width", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The width of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4667, + "name": "origin_country", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The country of origin of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4668, + "name": "mid_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Manufacturer Identification code of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4669, + "name": "material", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The material composition of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4670, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 4671, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product variant prices. A product variant can have different prices for each region or currency code." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4673, + "name": "ProductVariantPricesUpdateReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 4672, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of Product Option values that the variant corresponds to." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5009, + "name": "ProductVariantOptionReq", + "package": "@medusajs/medusa" + } + }, + "defaultValue": "[]" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4651 + ] + }, + { + "title": "Properties", + "children": [ + 4653, + 4654, + 4655, + 4656, + 4657, + 4658, + 4659, + 4660, + 4661, + 4662, + 4663, + 4664, + 4665, + 4666, + 4667, + 4668, + 4669, + 4670, + 4671, + 4672 + ] + } + ] + }, + { + "id": 1449, + "name": "AdminPostProductsProductReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the product." + } + ] + }, + "children": [ + { + "id": 1450, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1451, + "name": "new AdminPostProductsProductReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the product." + } + ] + }, + "type": { + "type": "reference", + "target": 1449, + "name": "AdminPostProductsProductReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1452, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Product" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1453, + "name": "subtitle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The subtitle of the Product" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1454, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1455, + "name": "discountable", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A flag to indicate if discounts can be applied to the Line Items generated from this Product" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1456, + "name": "images", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of images of the Product. Each value in the array is a URL to the image. You can use the upload API Routes to upload the image and obtain a URL." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1457, + "name": "thumbnail", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The thumbnail to use for the Product. The value is a URL to the thumbnail. You can use the upload API Routes to upload the thumbnail and obtain a URL." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1458, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique handle to identify the Product by. If not provided, the kebab-case version of the product title will be used. This can be used as a slug in URLs." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1459, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The status of the product. The product is shown to the customer only if its status is `published`." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "ProductStatus" + }, + "name": "ProductStatus", + "package": "@medusajs/medusa" + } + }, + { + "id": 1460, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Product Type to associate the Product with." + } + ] + }, + "type": { + "type": "reference", + "target": 4572, + "name": "ProductTypeReq", + "package": "@medusajs/medusa" + } + }, + { + "id": 1461, + "name": "collection_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Product Collection the Product belongs to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1462, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product Tags to associate the Product with." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4577, + "name": "ProductTagReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1463, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sales channels to associate the Product with." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": 4582, + "name": "ProductSalesChannelReq", + "package": "@medusajs/medusa" + } + } + ] + } + }, + { + "id": 1464, + "name": "categories", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product categories to add the Product to." + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "product_categories", + "tag": "@featureFlag" + } + ] + }, + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "product_categories", + "tag": "@featureFlag" + } + ] + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4586, + "name": "ProductProductCategoryReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1465, + "name": "variants", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of Product Variants to create with the Product. Each product variant must have a unique combination of Product Option values." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4650, + "name": "ProductVariantReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1466, + "name": "weight", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The weight of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1467, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The length of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1468, + "name": "height", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1469, + "name": "width", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The width of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1470, + "name": "hs_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Harmonized System code of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1471, + "name": "origin_country", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The country of origin of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1472, + "name": "mid_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Manufacturer Identification code of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1473, + "name": "material", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The material composition of the Product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1474, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1450 + ] + }, + { + "title": "Properties", + "children": [ + 1452, + 1453, + 1454, + 1455, + 1456, + 1457, + 1458, + 1459, + 1460, + 1461, + 1462, + 1463, + 1464, + 1465, + 1466, + 1467, + 1468, + 1469, + 1470, + 1471, + 1472, + 1473, + 1474 + ] + } + ] + }, + { + "id": 4682, + "name": "ProductVariantOptionReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4683, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4684, + "name": "new ProductVariantOptionReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4682, + "name": "ProductVariantOptionReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4685, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the Product Option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4686, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Product Option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4683 + ] + }, + { + "title": "Properties", + "children": [ + 4685, + 4686 + ] + } + ] + }, + { + "id": 1475, + "name": "AdminPostProductsProductVariantsVariantReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1476, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1477, + "name": "new AdminPostProductsProductVariantsVariantReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1475, + "name": "AdminPostProductsProductVariantsVariantReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1478, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1479, + "name": "sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The unique SKU of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1480, + "name": "ean", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The EAN number of the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1481, + "name": "upc", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The UPC number of the item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1482, + "name": "barcode", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A generic GTIN field of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1483, + "name": "hs_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Harmonized System code of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1484, + "name": "inventory_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of stock kept of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1485, + "name": "allow_backorder", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the product variant can be purchased when out of stock." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1486, + "name": "manage_inventory", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether Medusa should keep track of the inventory of this product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1487, + "name": "weight", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The weight of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1488, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The length of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1489, + "name": "height", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1490, + "name": "width", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The width of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1491, + "name": "origin_country", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The country of origin of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1492, + "name": "mid_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Manufacturer Identification code of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1493, + "name": "material", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The material composition of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1494, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1495, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product variant prices. A product variant can have different prices for each region or currency code." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4673, + "name": "ProductVariantPricesUpdateReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1496, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of Product Option values that the variant corresponds to." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4682, + "name": "ProductVariantOptionReq", + "package": "@medusajs/medusa" + } + }, + "defaultValue": "[]" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1476 + ] + }, + { + "title": "Properties", + "children": [ + 1478, + 1479, + 1480, + 1481, + 1482, + 1483, + 1484, + 1485, + 1486, + 1487, + 1488, + 1489, + 1490, + 1491, + 1492, + 1493, + 1494, + 1495, + 1496 + ] + } + ] + }, + { + "id": 1507, + "name": "AdminPostPublishableApiKeySalesChannelsBatchReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the sales channels to add to the publishable API key." + } + ] + }, + "children": [ + { + "id": 1508, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1509, + "name": "new AdminPostPublishableApiKeySalesChannelsBatchReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the sales channels to add to the publishable API key." + } + ] + }, + "type": { + "type": "reference", + "target": 1507, + "name": "AdminPostPublishableApiKeySalesChannelsBatchReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1510, + "name": "sales_channel_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the sales channels to add to the publishable API key" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4687, + "name": "ProductBatchSalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1508 + ] + }, + { + "title": "Properties", + "children": [ + 1510 + ] + } + ] + }, + { + "id": 1511, + "name": "AdminPostPublishableApiKeysReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the publishable API key to create." + } + ] + }, + "children": [ + { + "id": 1512, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1513, + "name": "new AdminPostPublishableApiKeysReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the publishable API key to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1511, + "name": "AdminPostPublishableApiKeysReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1514, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the publishable API key" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1512 + ] + }, + { + "title": "Properties", + "children": [ + 1514 + ] + } + ] + }, + { + "id": 1515, + "name": "AdminDeletePublishableApiKeySalesChannelsBatchReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the sales channels to remove from the publishable API key." + } + ] + }, + "children": [ + { + "id": 1516, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1517, + "name": "new AdminDeletePublishableApiKeySalesChannelsBatchReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the sales channels to remove from the publishable API key." + } + ] + }, + "type": { + "type": "reference", + "target": 1515, + "name": "AdminDeletePublishableApiKeySalesChannelsBatchReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1518, + "name": "sales_channel_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the sales channels to remove from the publishable API key" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4687, + "name": "ProductBatchSalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1516 + ] + }, + { + "title": "Properties", + "children": [ + 1518 + ] + } + ] + }, + { + "id": 1497, + "name": "AdminPublishableApiKeysRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The publishable API key's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1498, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1499, + "name": "publishable_api_key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Publishable API key details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/publishable-api-key.ts", + "qualifiedName": "PublishableApiKey" + }, + "name": "PublishableApiKey", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1499 + ] + } + ] + } + } + }, + { + "id": 1500, + "name": "AdminPublishableApiKeysListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of publishable API keys with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1501, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1502, + "name": "publishable_api_keys", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of publishable API keys details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/publishable-api-key.ts", + "qualifiedName": "PublishableApiKey" + }, + "name": "PublishableApiKey", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1502 + ] + } + ] + } + } + ] + } + }, + { + "id": 1503, + "name": "AdminPublishableApiKeyDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 1504, + "name": "AdminPublishableApiKeysListSalesChannelsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of sales channel." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1505, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1506, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of sales channels details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1506 + ] + } + ] + } + } + }, + { + "id": 1519, + "name": "GetPublishableApiKeySalesChannelsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter the sales channels." + } + ] + }, + "children": [ + { + "id": 1520, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1521, + "name": "new GetPublishableApiKeySalesChannelsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1519, + "name": "GetPublishableApiKeySalesChannelsParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1522, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search sales channels' names and descriptions." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1520 + ] + }, + { + "title": "Properties", + "children": [ + 1522 + ] + } + ] + }, + { + "id": 1523, + "name": "GetPublishableApiKeysParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved publishable API keys." + } + ] + }, + "children": [ + { + "id": 1527, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search publishable API keys' titles." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1528, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).expand" + } + }, + { + "id": 1529, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).fields" + } + }, + { + "id": 1530, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).offset" + } + }, + { + "id": 1531, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).limit" + } + }, + { + "id": 1524, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1525, + "name": "new GetPublishableApiKeysParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 1526, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 1523, + "name": "GetPublishableApiKeysParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1524 + ] + }, + { + "title": "Properties", + "children": [ + 1527, + 1528, + 1529, + 1530, + 1531 + ] + } + ], + "extendedTypes": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ] + }, + { + "id": 1532, + "name": "AdminPostPublishableApiKeysPublishableApiKeyReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the publishable API key." + } + ] + }, + "children": [ + { + "id": 1533, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1534, + "name": "new AdminPostPublishableApiKeysPublishableApiKeyReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the publishable API key." + } + ] + }, + "type": { + "type": "reference", + "target": 1532, + "name": "AdminPostPublishableApiKeysPublishableApiKeyReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1535, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the Publishable API Key." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1533 + ] + }, + { + "title": "Properties", + "children": [ + 1535 + ] + } + ] + }, + { + "id": 1554, + "name": "AdminPostRegionsRegionCountriesReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the country to add to the region." + } + ] + }, + "children": [ + { + "id": 1555, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1556, + "name": "new AdminPostRegionsRegionCountriesReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the country to add to the region." + } + ] + }, + "type": { + "type": "reference", + "target": 1554, + "name": "AdminPostRegionsRegionCountriesReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1557, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The 2 character ISO code for the Country." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1555 + ] + }, + { + "title": "Properties", + "children": [ + 1557 + ] + } + ] + }, + { + "id": 1558, + "name": "AdminPostRegionsRegionFulfillmentProvidersReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the fulfillment provider to add to the region." + } + ] + }, + "children": [ + { + "id": 1559, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1560, + "name": "new AdminPostRegionsRegionFulfillmentProvidersReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the fulfillment provider to add to the region." + } + ] + }, + "type": { + "type": "reference", + "target": 1558, + "name": "AdminPostRegionsRegionFulfillmentProvidersReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1561, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Fulfillment Provider." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1559 + ] + }, + { + "title": "Properties", + "children": [ + 1561 + ] + } + ] + }, + { + "id": 1562, + "name": "AdminPostRegionsRegionPaymentProvidersReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment provider to add to the region." + } + ] + }, + "children": [ + { + "id": 1563, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1564, + "name": "new AdminPostRegionsRegionPaymentProvidersReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment provider to add to the region." + } + ] + }, + "type": { + "type": "reference", + "target": 1562, + "name": "AdminPostRegionsRegionPaymentProvidersReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1565, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Payment Provider." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1563 + ] + }, + { + "title": "Properties", + "children": [ + 1565 + ] + } + ] + }, + { + "id": 1566, + "name": "AdminPostRegionsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the region to create." + } + ] + }, + "children": [ + { + "id": 1567, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1568, + "name": "new AdminPostRegionsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the region to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1566, + "name": "AdminPostRegionsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1569, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Region" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1570, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The 3 character ISO currency code to use in the Region." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1571, + "name": "tax_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax code of the Region." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1572, + "name": "tax_rate", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate to use in the Region." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1573, + "name": "payment_providers", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of Payment Provider IDs that can be used in the Region" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1574, + "name": "fulfillment_providers", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of Fulfillment Provider IDs that can be used in the Region" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1575, + "name": "countries", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of countries' 2 ISO characters that should be included in the Region." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1576, + "name": "includes_tax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether taxes are included in the prices of the region." + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "tax_inclusive_pricing", + "tag": "@featureFlag" + } + ] + }, + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "tax_inclusive_pricing", + "tag": "@featureFlag" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1577, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1567 + ] + }, + { + "title": "Properties", + "children": [ + 1569, + 1570, + 1571, + 1572, + 1573, + 1574, + 1575, + 1576, + 1577 + ] + } + ] }, { "id": 1536, @@ -113487,6 +42933,1472 @@ }, "defaultValue": "..." }, + { + "id": 1538, + "name": "AdminRegionsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1539, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1540, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Region details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/region.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1540 + ] + } + ] + } + } + }, + { + "id": 1541, + "name": "AdminRegionsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of regions with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1542, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1543, + "name": "regions", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of regions details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/region.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1543 + ] + } + ] + } + } + ] + } + }, + { + "id": 1544, + "name": "AdminRegionsDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 1545, + "name": "FulfillmentOption", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1546, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1547, + "name": "new FulfillmentOption", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1545, + "name": "FulfillmentOption", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1548, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the fulfillment provider" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1549, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "fulfillment provider options" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1546 + ] + }, + { + "title": "Properties", + "children": [ + 1548, + 1549 + ] + } + ] + }, + { + "id": 1550, + "name": "AdminGetRegionsRegionFulfillmentOptionsRes", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of fulfillment options in a region." + } + ] + }, + "children": [ + { + "id": 1551, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1552, + "name": "new AdminGetRegionsRegionFulfillmentOptionsRes", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of fulfillment options in a region." + } + ] + }, + "type": { + "type": "reference", + "target": 1550, + "name": "AdminGetRegionsRegionFulfillmentOptionsRes", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1553, + "name": "fulfillment_options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fulfillment providers details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1545, + "name": "FulfillmentOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1551 + ] + }, + { + "title": "Properties", + "children": [ + 1553 + ] + } + ] + }, + { + "id": 1578, + "name": "AdminGetRegionsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved regions." + } + ] + }, + "children": [ + { + "id": 1582, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the regions' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1583, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the regions' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1584, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the regions' " + }, + { + "kind": "code", + "text": "`deleted_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1585, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 50,\n offset: 0,\n}).expand" + } + }, + { + "id": 1586, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 50,\n offset: 0,\n}).fields" + } + }, + { + "id": 1587, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 50,\n offset: 0,\n}).offset" + } + }, + { + "id": 1588, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 50,\n offset: 0,\n}).limit" + } + }, + { + "id": 1579, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1580, + "name": "new AdminGetRegionsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 1581, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 1578, + "name": "AdminGetRegionsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 50,\n offset: 0,\n}).constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 50,\n offset: 0,\n}).constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1579 + ] + }, + { + "title": "Properties", + "children": [ + 1582, + 1583, + 1584, + 1585, + 1586, + 1587, + 1588 + ] + } + ], + "extendedTypes": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ] + }, + { + "id": 1589, + "name": "AdminPostRegionsRegionReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the regions." + } + ] + }, + "children": [ + { + "id": 1590, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1591, + "name": "new AdminPostRegionsRegionReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the regions." + } + ] + }, + "type": { + "type": "reference", + "target": 1589, + "name": "AdminPostRegionsRegionReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1592, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Region" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1593, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The 3 character ISO currency code to use in the Region." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1594, + "name": "tax_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax code of the Region." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1595, + "name": "tax_rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate to use in the Region." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1596, + "name": "gift_cards_taxable", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, taxes will be applied on gift cards." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1597, + "name": "automatic_taxes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, the Medusa backend will automatically calculate taxes for carts in this region. If set to `false`, the taxes must be calculated manually." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1598, + "name": "tax_provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the tax provider to use. If none provided, the system tax provider is used." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1599, + "name": "payment_providers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of Payment Provider IDs that can be used in the Region" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1600, + "name": "fulfillment_providers", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of Fulfillment Provider IDs that can be used in the Region" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1601, + "name": "countries", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A list of countries' 2 ISO characters that should be included in the Region." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1602, + "name": "includes_tax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether taxes are included in the prices of the region." + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "tax_inclusive_pricing", + "tag": "@featureFlag" + } + ] + }, + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "tax_inclusive_pricing", + "tag": "@featureFlag" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1603, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1590 + ] + }, + { + "title": "Properties", + "children": [ + 1592, + 1593, + 1594, + 1595, + 1596, + 1597, + 1598, + 1599, + 1600, + 1601, + 1602, + 1603 + ] + } + ] + }, + { + "id": 1665, + "name": "AdminPostReservationsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the reservation to create." + } + ] + }, + "children": [ + { + "id": 1666, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1667, + "name": "new AdminPostReservationsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the reservation to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1665, + "name": "AdminPostReservationsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1668, + "name": "line_item_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the line item of the reservation." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1669, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the location of the reservation." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1670, + "name": "inventory_item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the inventory item the reservation is associated with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1671, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity to reserve." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1672, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reservation's description." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1673, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1666 + ] + }, + { + "title": "Properties", + "children": [ + 1668, + 1669, + 1670, + 1671, + 1672, + 1673 + ] + } + ] + }, + { + "id": 1652, + "name": "AdminReservationsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reservation's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1653, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1654, + "name": "reservation", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Reservation details." + } + ] + }, + "type": { + "type": "reference", + "target": 4696, + "name": "ReservationItemDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1654 + ] + } + ] + } + } + }, + { + "id": 1655, + "name": "ExtendedReservationItem", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 4696, + "name": "ReservationItemDTO", + "package": "@medusajs/types" + }, + { + "type": "reflection", + "declaration": { + "id": 1656, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1657, + "name": "line_item", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item associated with the reservation." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", + "qualifiedName": "LineItem" + }, + "name": "LineItem", + "package": "@medusajs/medusa" + } + }, + { + "id": 1658, + "name": "inventory_item", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item associated with the reservation." + } + ] + }, + "type": { + "type": "reference", + "target": 4393, + "name": "InventoryItemDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1657, + 1658 + ] + } + ] + } + } + ] + } + }, + { + "id": 1659, + "name": "AdminReservationsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of reservations with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1660, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1661, + "name": "reservations", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of reservations details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4696, + "name": "ReservationItemDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1661 + ] + } + ] + } + } + ] + } + }, { "id": 1662, "name": "defaultAdminReservationRelations", @@ -113504,6 +44416,843 @@ }, "defaultValue": "[]" }, + { + "id": 1663, + "name": "defaultReservationFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 1664, + "name": "AdminReservationsDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 1674, + "name": "AdminGetReservationsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved reservations." + } + ] + }, + "children": [ + { + "id": 1678, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Location IDs to filter reservations by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 1679, + "name": "inventory_item_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Inventory item IDs to filter reservations by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1680, + "name": "line_item_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Line item IDs to filter reservations by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1681, + "name": "created_by", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "\"Create by\" user IDs to filter reservations by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1682, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Numerical filters to apply on the reservations' " + }, + { + "kind": "code", + "text": "`quantity`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "reference", + "target": 3935, + "name": "NumericalComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1683, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the reservations' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1684, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "String filters tp apply on the reservations' " + }, + { + "kind": "code", + "text": "`description`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 1685, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).expand" + } + }, + { + "id": 1686, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).fields" + } + }, + { + "id": 1687, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).offset" + } + }, + { + "id": 1688, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).limit" + } + }, + { + "id": 1675, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1676, + "name": "new AdminGetReservationsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 1677, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 1674, + "name": "AdminGetReservationsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1675 + ] + }, + { + "title": "Properties", + "children": [ + 1678, + 1679, + 1680, + 1681, + 1682, + 1683, + 1684, + 1685, + 1686, + 1687, + 1688 + ] + } + ], + "extendedTypes": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ] + }, + { + "id": 1689, + "name": "AdminPostReservationsReservationReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the reservation." + } + ] + }, + "children": [ + { + "id": 1690, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1691, + "name": "new AdminPostReservationsReservationReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the reservation." + } + ] + }, + "type": { + "type": "reference", + "target": 1689, + "name": "AdminPostReservationsReservationReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1692, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity to reserve." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1693, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the location associated with the reservation." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1694, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reservation's description." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1695, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1690 + ] + }, + { + "title": "Properties", + "children": [ + 1692, + 1693, + 1694, + 1695 + ] + } + ] + }, + { + "id": 1613, + "name": "AdminPostReturnReasonsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the return reason to create." + } + ] + }, + "children": [ + { + "id": 1614, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1615, + "name": "new AdminPostReturnReasonsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the return reason to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1613, + "name": "AdminPostReturnReasonsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1616, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique value of the return reason." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1617, + "name": "label", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The label to display to the Customer." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1618, + "name": "parent_return_reason_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the parent return reason." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1619, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the Reason." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1620, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1614 + ] + }, + { + "title": "Properties", + "children": [ + 1616, + 1617, + 1618, + 1619, + 1620 + ] + } + ] + }, { "id": 1604, "name": "defaultAdminReturnReasonsFields", @@ -113556,6 +45305,3367 @@ }, "defaultValue": "..." }, + { + "id": 1606, + "name": "AdminReturnReasonsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return reason's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1607, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1608, + "name": "return_reason", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return reason's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/return-reason.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1608 + ] + } + ] + } + } + }, + { + "id": 1609, + "name": "AdminReturnReasonsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of return reasons." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1610, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1611, + "name": "return_reasons", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of return reasons." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/return-reason.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1611 + ] + } + ] + } + } + }, + { + "id": 1612, + "name": "AdminReturnReasonsDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 1621, + "name": "AdminPostReturnReasonsReasonReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the return reason." + } + ] + }, + "children": [ + { + "id": 1622, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1623, + "name": "new AdminPostReturnReasonsReasonReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the return reason." + } + ] + }, + "type": { + "type": "reference", + "target": 1621, + "name": "AdminPostReturnReasonsReasonReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1624, + "name": "label", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The label to display to the Customer." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1625, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A unique value of the return reason." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1626, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the Reason." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1627, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1622 + ] + }, + { + "title": "Properties", + "children": [ + 1624, + 1625, + 1626, + 1627 + ] + } + ] + }, + { + "id": 1628, + "name": "defaultRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 1629, + "name": "defaultRelationsList", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 1630, + "name": "defaultReturnCancelRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 1631, + "name": "defaultReturnCancelFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + }, + "defaultValue": "..." + }, + { + "id": 1632, + "name": "AdminReturnsCancelRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated order's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1633, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1634, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Order details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1634 + ] + } + ] + } + } + }, + { + "id": 1635, + "name": "AdminReturnsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of returns with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1636, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1637, + "name": "returns", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of returns details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/return.ts", + "qualifiedName": "Return" + }, + "name": "Return", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1637 + ] + } + ] + } + } + ] + } + }, + { + "id": 1638, + "name": "AdminReturnsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1639, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1640, + "name": "return", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/return.ts", + "qualifiedName": "Return" + }, + "name": "Return", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1640 + ] + } + ] + } + } + }, + { + "id": 1641, + "name": "AdminGetReturnsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how a list of data is paginated." + } + ] + }, + "children": [ + { + "id": 1642, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1643, + "name": "new AdminGetReturnsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1641, + "name": "AdminGetReturnsParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1644, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n50\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "50" + }, + { + "id": 1645, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n50\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1642 + ] + }, + { + "title": "Properties", + "children": [ + 1644, + 1645 + ] + } + ] + }, + { + "id": 4691, + "name": "Item", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4692, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4693, + "name": "new Item", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4691, + "name": "Item", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4694, + "name": "item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Line Item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4695, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the Line Item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4692 + ] + }, + { + "title": "Properties", + "children": [ + 4694, + 4695 + ] + } + ] + }, + { + "id": 1646, + "name": "AdminPostReturnsReturnReceiveReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the received return." + } + ] + }, + "children": [ + { + "id": 1647, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1648, + "name": "new AdminPostReturnsReturnReceiveReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the received return." + } + ] + }, + "type": { + "type": "reference", + "target": 1646, + "name": "AdminPostReturnsReturnReceiveReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1649, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Line Items that have been received." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4691, + "name": "Item", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1650, + "name": "refund", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount to refund." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1651, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the location to return items from." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1647 + ] + }, + { + "title": "Properties", + "children": [ + 1649, + 1650, + 1651 + ] + } + ] + }, + { + "id": 1704, + "name": "AdminPostSalesChannelsChannelProductsBatchReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to add to the sales channel." + } + ] + }, + "children": [ + { + "id": 1705, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1706, + "name": "new AdminPostSalesChannelsChannelProductsBatchReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to add to the sales channel." + } + ] + }, + "type": { + "type": "reference", + "target": 1704, + "name": "AdminPostSalesChannelsChannelProductsBatchReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1707, + "name": "product_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the products to add to the sales channel" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4687, + "name": "ProductBatchSalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1705 + ] + }, + { + "title": "Properties", + "children": [ + 1707 + ] + } + ] + }, + { + "id": 1740, + "name": "AdminPostSalesChannelsChannelStockLocationsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1741, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1742, + "name": "new AdminPostSalesChannelsChannelStockLocationsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1740, + "name": "AdminPostSalesChannelsChannelStockLocationsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1743, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the stock location" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1741 + ] + }, + { + "title": "Properties", + "children": [ + 1743 + ] + } + ] + }, + { + "id": 1708, + "name": "AdminPostSalesChannelsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the sales channel to create." + } + ] + }, + "children": [ + { + "id": 1709, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1710, + "name": "new AdminPostSalesChannelsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the sales channel to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1708, + "name": "AdminPostSalesChannelsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1711, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Sales Channel" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1712, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the Sales Channel" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1713, + "name": "is_disabled", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Sales Channel is disabled." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1709 + ] + }, + { + "title": "Properties", + "children": [ + 1711, + 1712, + 1713 + ] + } + ] + }, + { + "id": 1714, + "name": "AdminDeleteSalesChannelsChannelProductsBatchReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to delete from the sales channel." + } + ] + }, + "children": [ + { + "id": 1715, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1716, + "name": "new AdminDeleteSalesChannelsChannelProductsBatchReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to delete from the sales channel." + } + ] + }, + "type": { + "type": "reference", + "target": 1714, + "name": "AdminDeleteSalesChannelsChannelProductsBatchReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1717, + "name": "product_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the products to remove from the sales channel." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4687, + "name": "ProductBatchSalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1715 + ] + }, + { + "title": "Properties", + "children": [ + 1717 + ] + } + ] + }, + { + "id": 1696, + "name": "AdminSalesChannelsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The sales channel's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1697, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1698, + "name": "sales_channel", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sales Channel's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1698 + ] + } + ] + } + } + }, + { + "id": 1699, + "name": "AdminSalesChannelsDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 1700, + "name": "AdminSalesChannelsDeleteLocationRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 1701, + "name": "AdminSalesChannelsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of sales channels with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1702, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1703, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of sales channels details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/sales-channel.ts", + "qualifiedName": "SalesChannel" + }, + "name": "SalesChannel", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1703 + ] + } + ] + } + } + ] + } + }, + { + "id": 1718, + "name": "AdminGetSalesChannelsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved sales channels." + } + ] + }, + "children": [ + { + "id": 1722, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID to filter sales channels by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1723, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search sales channels' names and descriptions." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1724, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name to filter sales channels by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1725, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description to filter sales channels by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1726, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on sales channels' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1727, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on sales channels' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1728, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on sales channels' " + }, + { + "kind": "code", + "text": "`deleted_at`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 1729, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1730, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin().expand" + } + }, + { + "id": 1731, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin().fields" + } + }, + { + "id": 1732, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin().offset" + } + }, + { + "id": 1733, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin().limit" + } + }, + { + "id": 1719, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1720, + "name": "new AdminGetSalesChannelsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 1721, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 1718, + "name": "AdminGetSalesChannelsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin().constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin().constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1719 + ] + }, + { + "title": "Properties", + "children": [ + 1722, + 1723, + 1724, + 1725, + 1726, + 1727, + 1728, + 1729, + 1730, + 1731, + 1732, + 1733 + ] + } + ], + "extendedTypes": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ] + }, + { + "id": 1744, + "name": "AdminDeleteSalesChannelsChannelStockLocationsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 1745, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1746, + "name": "new AdminDeleteSalesChannelsChannelStockLocationsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1744, + "name": "AdminDeleteSalesChannelsChannelStockLocationsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1747, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the stock location" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1745 + ] + }, + { + "title": "Properties", + "children": [ + 1747 + ] + } + ] + }, + { + "id": 1734, + "name": "AdminPostSalesChannelsSalesChannelReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the sales channel." + } + ] + }, + "children": [ + { + "id": 1735, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1736, + "name": "new AdminPostSalesChannelsSalesChannelReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the sales channel." + } + ] + }, + "type": { + "type": "reference", + "target": 1734, + "name": "AdminPostSalesChannelsSalesChannelReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1737, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the sales channel" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1738, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the sales channel." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1739, + "name": "is_disabled", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Sales Channel is disabled." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1735 + ] + }, + { + "title": "Properties", + "children": [ + 1737, + 1738, + 1739 + ] + } + ] + }, + { + "id": 4709, + "name": "OptionRequirement", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4710, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4711, + "name": "new OptionRequirement", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4709, + "name": "OptionRequirement", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4712, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the requirement" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-option-requirement.ts", + "qualifiedName": "RequirementType" + }, + "name": "RequirementType", + "package": "@medusajs/medusa" + } + }, + { + "id": 4713, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount to compare with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4710 + ] + }, + { + "title": "Properties", + "children": [ + 4712, + 4713 + ] + } + ] + }, + { + "id": 1756, + "name": "AdminPostShippingOptionsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping option to create." + } + ] + }, + "children": [ + { + "id": 1757, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1758, + "name": "new AdminPostShippingOptionsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping option to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1756, + "name": "AdminPostShippingOptionsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1759, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Shipping Option" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1760, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Region in which the Shipping Option will be available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1761, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Fulfillment Provider that handles the Shipping Option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1762, + "name": "profile_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Shipping Profile to add the Shipping Option to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1763, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data needed for the Fulfillment Provider to handle shipping with this Shipping Option." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1764, + "name": "price_type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the Shipping Option price. `flat_rate` indicates fixed pricing, whereas `calculated` indicates that the price will be calculated each time by the fulfillment provider." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", + "qualifiedName": "ShippingOptionPriceType" + }, + "name": "ShippingOptionPriceType", + "package": "@medusajs/medusa" + } + }, + { + "id": 1765, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount to charge for the Shipping Option. If the `price_type` is set to `calculated`, this amount will not actually be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1766, + "name": "requirements", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The requirements that must be satisfied for the Shipping Option to be available." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4709, + "name": "OptionRequirement", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1767, + "name": "admin_only", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, the shipping option can only be used when creating draft orders." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 1768, + "name": "is_return", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the Shipping Option can be used for returns or during checkout." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 1769, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1770, + "name": "includes_tax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tax included in prices of shipping option" + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "tax_inclusive_pricing", + "tag": "@featureFlag" + } + ] + }, + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "tax_inclusive_pricing", + "tag": "@featureFlag" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1757 + ] + }, + { + "title": "Properties", + "children": [ + 1759, + 1760, + 1761, + 1762, + 1763, + 1764, + 1765, + 1766, + 1767, + 1768, + 1769, + 1770 + ] + } + ] + }, + { + "id": 1748, + "name": "defaultFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", + "qualifiedName": "ShippingOption" + }, + "name": "ShippingOption", + "package": "@medusajs/medusa" + } + } + }, + "defaultValue": "..." + }, + { + "id": 1749, + "name": "AdminShippingOptionsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of shipping options with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1750, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1751, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of shipping options details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", + "qualifiedName": "ShippingOption" + }, + "name": "ShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1751 + ] + } + ] + } + } + ] + } + }, + { + "id": 1752, + "name": "AdminShippingOptionsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping option's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1753, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1754, + "name": "shipping_option", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Shipping option details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", + "qualifiedName": "ShippingOption" + }, + "name": "ShippingOption", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1754 + ] + } + ] + } + } + }, + { + "id": 1755, + "name": "AdminShippingOptionsDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 1771, + "name": "AdminGetShippingOptionsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter the retrieved shipping options." + } + ] + }, + "children": [ + { + "id": 1772, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1773, + "name": "new AdminGetShippingOptionsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1771, + "name": "AdminGetShippingOptionsParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1774, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter shipping options by the ID of the region they belong to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1775, + "name": "is_return", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter shipping options by whether they're return shipping options." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1776, + "name": "admin_only", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter shipping options by whether they're available for admin users only." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1772 + ] + }, + { + "title": "Properties", + "children": [ + 1774, + 1775, + 1776 + ] + } + ] + }, + { + "id": 4714, + "name": "OptionRequirement", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4715, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4716, + "name": "new OptionRequirement", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4714, + "name": "OptionRequirement", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4717, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of an existing requirement. If an ID is passed, the existing requirement's details are updated. Otherwise, a new requirement is created." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4718, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the requirement" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4719, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount to compare with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4715 + ] + }, + { + "title": "Properties", + "children": [ + 4717, + 4718, + 4719 + ] + } + ] + }, + { + "id": 1777, + "name": "AdminPostShippingOptionsOptionReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the shipping option." + } + ] + }, + "children": [ + { + "id": 1778, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1779, + "name": "new AdminPostShippingOptionsOptionReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the shipping option." + } + ] + }, + "type": { + "type": "reference", + "target": 1777, + "name": "AdminPostShippingOptionsOptionReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1780, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Shipping Option" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1781, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount to charge for the Shipping Option. If the `price_type` of the shipping option is `calculated`, this amount will not actually be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1782, + "name": "price_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", + "qualifiedName": "ShippingOptionPriceType" + }, + "name": "ShippingOptionPriceType", + "package": "@medusajs/medusa" + } + }, + { + "id": 1783, + "name": "requirements", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The requirements that must be satisfied for the Shipping Option to be available." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4714, + "name": "OptionRequirement", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 1784, + "name": "admin_only", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If set to `true`, the shipping option can only be used when creating draft orders." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1785, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1786, + "name": "includes_tax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tax included in prices of shipping option" + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "tax_inclusive_pricing", + "tag": "@featureFlag" + } + ] + }, + { + "tag": "@featureFlag", + "content": [ + { + "kind": "inline-tag", + "text": "tax_inclusive_pricing", + "tag": "@featureFlag" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1778 + ] + }, + { + "title": "Properties", + "children": [ + 1780, + 1781, + 1782, + 1783, + 1784, + 1785, + 1786 + ] + } + ] + }, + { + "id": 1796, + "name": "AdminPostShippingProfilesReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping profile to create." + } + ] + }, + "children": [ + { + "id": 1797, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1798, + "name": "new AdminPostShippingProfilesReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping profile to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1796, + "name": "AdminPostShippingProfilesReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1799, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Shipping Profile" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1800, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the Shipping Profile" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", + "qualifiedName": "ShippingProfileType" + }, + "name": "ShippingProfileType", + "package": "@medusajs/medusa" + } + }, + { + "id": 1801, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1797 + ] + }, + { + "title": "Properties", + "children": [ + 1799, + 1800, + 1801 + ] + } + ] + }, { "id": 1787, "name": "defaultAdminShippingProfilesFields", @@ -113599,6 +48709,975 @@ }, "defaultValue": "..." }, + { + "id": 1789, + "name": "AdminDeleteShippingProfileRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 1790, + "name": "AdminShippingProfilesRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping profile's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1791, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1792, + "name": "shipping_profile", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Shipping profile details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", + "qualifiedName": "ShippingProfile" + }, + "name": "ShippingProfile", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1792 + ] + } + ] + } + } + }, + { + "id": 1793, + "name": "AdminShippingProfilesListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of shipping profiles." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1794, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1795, + "name": "shipping_profiles", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of shipping profiles details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", + "qualifiedName": "ShippingProfile" + }, + "name": "ShippingProfile", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1795 + ] + } + ] + } + } + }, + { + "id": 1802, + "name": "AdminPostShippingProfilesProfileReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The detail to update of the shipping profile." + } + ] + }, + "children": [ + { + "id": 1803, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1804, + "name": "new AdminPostShippingProfilesProfileReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The detail to update of the shipping profile." + } + ] + }, + "type": { + "type": "reference", + "target": 1802, + "name": "AdminPostShippingProfilesProfileReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1805, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Shipping Profile" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1806, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1807, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the Shipping Profile" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-profile.ts", + "qualifiedName": "ShippingProfileType" + }, + "name": "ShippingProfileType", + "package": "@medusajs/medusa" + } + }, + { + "id": 1808, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "product IDs to associate with the Shipping Profile" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1809, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Shipping option IDs to associate with the Shipping Profile" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1803 + ] + }, + { + "title": "Properties", + "children": [ + 1805, + 1806, + 1807, + 1808, + 1809 + ] + } + ] + }, + { + "id": 4738, + "name": "StockLocationAddress", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4739, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4740, + "name": "new StockLocationAddress", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4738, + "name": "StockLocationAddress", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4741, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4742, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' complement" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4743, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' company" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4744, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' city" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4745, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The two character ISO code for the country." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4746, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' phone number" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4747, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' postal code" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4748, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' province" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4739 + ] + }, + { + "title": "Properties", + "children": [ + 4741, + 4742, + 4743, + 4744, + 4745, + 4746, + 4747, + 4748 + ] + } + ] + }, + { + "id": 1819, + "name": "AdminPostStockLocationsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the stock location to create." + } + ] + }, + "children": [ + { + "id": 1820, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1821, + "name": "new AdminPostStockLocationsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the stock location to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1819, + "name": "AdminPostStockLocationsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1822, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the name of the stock location" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1823, + "name": "address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A new stock location address to create and associate with the stock location. Only required if `address_id` is not provided." + } + ] + }, + "type": { + "type": "reference", + "target": 4738, + "name": "StockLocationAddress", + "package": "@medusajs/medusa" + } + }, + { + "id": 1824, + "name": "address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the ID of an existing stock location address to associate with the stock location. Only required if `address` is not provided." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1825, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional key-value map with additional details" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1820 + ] + }, + { + "title": "Properties", + "children": [ + 1822, + 1823, + 1824, + 1825 + ] + } + ] + }, + { + "id": 1826, + "name": "AdminPostStockLocationsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1827, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1828, + "name": "new AdminPostStockLocationsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1826, + "name": "AdminPostStockLocationsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 1829, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 1830, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1827 + ] + }, + { + "title": "Properties", + "children": [ + 1829, + 1830 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1831, + "name": "AdminGetStockLocationsLocationParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1832, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1833, + "name": "new AdminGetStockLocationsLocationParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1831, + "name": "AdminGetStockLocationsLocationParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 1834, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 1835, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1832 + ] + }, + { + "title": "Properties", + "children": [ + 1834, + 1835 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, { "id": 1810, "name": "defaultAdminStockLocationFields", @@ -113614,7 +49693,7 @@ "operator": "keyof", "target": { "type": "reference", - "target": 4713, + "target": 4720, "name": "StockLocationTypes.StockLocationDTO", "package": "@medusajs/types", "qualifiedName": "StockLocationDTO" @@ -113641,8 +49720,1053 @@ "defaultValue": "[]" }, { - "id": 1884, - "name": "defaultAdminSwapFields", + "id": 1812, + "name": "AdminStockLocationsDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 4730, + "name": "DeleteResponse", + "package": "@medusajs/types" + } + }, + { + "id": 1813, + "name": "AdminStockLocationsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The stock location's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1814, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1815, + "name": "stock_location", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location details." + } + ] + }, + "type": { + "type": "reference", + "target": 4735, + "name": "StockLocationTypes.StockLocationExpandedDTO", + "package": "@medusajs/types", + "qualifiedName": "StockLocationExpandedDTO" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1815 + ] + } + ] + } + } + }, + { + "id": 1816, + "name": "AdminStockLocationsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of stock locations with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 4425, + "name": "PaginatedResponse", + "package": "@medusajs/types" + }, + { + "type": "reflection", + "declaration": { + "id": 1817, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1818, + "name": "stock_locations", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of stock locations." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4735, + "name": "StockLocationTypes.StockLocationExpandedDTO", + "package": "@medusajs/types", + "qualifiedName": "StockLocationExpandedDTO" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1818 + ] + } + ] + } + } + ] + } + }, + { + "id": 1836, + "name": "AdminGetStockLocationsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved stock locations." + } + ] + }, + "children": [ + { + "id": 1840, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter stock locations by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 1841, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Names to filter stock locations by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 1842, + "name": "address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter stock locations by the ID of their associated addresses." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 1843, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter stock locations by the ID of their associated sales channels." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 1844, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).expand" + } + }, + { + "id": 1845, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).fields" + } + }, + { + "id": 1846, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).offset" + } + }, + { + "id": 1847, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).limit" + } + }, + { + "id": 1837, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1838, + "name": "new AdminGetStockLocationsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 1839, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 1836, + "name": "AdminGetStockLocationsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 20,\n offset: 0,\n}).constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1837 + ] + }, + { + "title": "Properties", + "children": [ + 1840, + 1841, + 1842, + 1843, + 1844, + 1845, + 1846, + 1847 + ] + } + ], + "extendedTypes": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ] + }, + { + "id": 4749, + "name": "StockLocationAddress", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attributes of a stock location address to create or update." + } + ] + }, + "children": [ + { + "id": 4750, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4751, + "name": "new StockLocationAddress", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4749, + "name": "StockLocationAddress", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4752, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "First line address." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4753, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Second line address." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4754, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Company." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4755, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "City." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4756, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Country code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4757, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Phone." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4758, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Postal code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4759, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Province." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4750 + ] + }, + { + "title": "Properties", + "children": [ + 4752, + 4753, + 4754, + 4755, + 4756, + 4757, + 4758, + 4759 + ] + } + ] + }, + { + "id": 1848, + "name": "AdminPostStockLocationsLocationReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the stock location." + } + ] + }, + "children": [ + { + "id": 1849, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1850, + "name": "new AdminPostStockLocationsLocationReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the stock location." + } + ] + }, + "type": { + "type": "reference", + "target": 1848, + "name": "AdminPostStockLocationsLocationReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1851, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the name of the stock location" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1852, + "name": "address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data of an associated address to create or update." + } + ] + }, + "type": { + "type": "reference", + "target": 4749, + "name": "StockLocationAddress", + "package": "@medusajs/medusa" + } + }, + { + "id": 1853, + "name": "address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the stock location address ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1854, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional key-value map with additional details" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1849 + ] + }, + { + "title": "Properties", + "children": [ + 1851, + 1852, + 1853, + 1854 + ] + } + ] + }, + { + "id": 1855, + "name": "AdminPostStockLocationsLocationParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1856, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1857, + "name": "new AdminPostStockLocationsLocationParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1855, + "name": "AdminPostStockLocationsLocationParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 1858, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 1859, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1856 + ] + }, + { + "title": "Properties", + "children": [ + 1858, + 1859 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1860, + "name": "defaultRelationsExtended", "variant": "declaration", "kind": 32, "flags": { @@ -113657,6 +50781,489 @@ }, "defaultValue": "..." }, + { + "id": 1861, + "name": "AdminExtendedStoresRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The store's details with additional details like payment and tax providers." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1862, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1863, + "name": "store", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Store details." + } + ] + }, + "type": { + "type": "reference", + "target": 4760, + "name": "ExtendedStoreDTO", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1863 + ] + } + ] + } + } + }, + { + "id": 1864, + "name": "AdminStoresRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The store's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1865, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1866, + "name": "store", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Store details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/store.ts", + "qualifiedName": "Store" + }, + "name": "Store", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1866 + ] + } + ] + } + } + }, + { + "id": 1867, + "name": "AdminTaxProvidersList", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of tax providers in a store." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1868, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1869, + "name": "tax_providers", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of tax providers details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/tax-provider.ts", + "qualifiedName": "TaxProvider" + }, + "name": "TaxProvider", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1869 + ] + } + ] + } + } + }, + { + "id": 1870, + "name": "AdminPaymentProvidersList", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of payment providers in a store." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1871, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1872, + "name": "payment_providers", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of payment providers details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-provider.ts", + "qualifiedName": "PaymentProvider" + }, + "name": "PaymentProvider", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1872 + ] + } + ] + } + } + }, + { + "id": 1873, + "name": "AdminPostStoreReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the store." + } + ] + }, + "children": [ + { + "id": 1874, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1875, + "name": "new AdminPostStoreReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the store." + } + ] + }, + "type": { + "type": "reference", + "target": 1873, + "name": "AdminPostStoreReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1876, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the Store" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1877, + "name": "swap_link_template", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A template for Swap links - use `{{cart_id}}` to insert the Swap Cart ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1878, + "name": "payment_link_template", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A template for payment links - use `{{cart_id}}` to insert the Cart ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1879, + "name": "invite_link_template", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A template for invite links - use `{{invite_token}}` to insert the invite token" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1880, + "name": "default_currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The default currency code of the Store." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1881, + "name": "currencies", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Array of available currencies in the store. Each currency is in 3 character ISO code format." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1882, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1874 + ] + }, + { + "title": "Properties", + "children": [ + 1876, + 1877, + 1878, + 1879, + 1880, + 1881, + 1882 + ] + } + ] + }, { "id": 1883, "name": "defaultAdminSwapRelations", @@ -113674,6 +51281,1261 @@ }, "defaultValue": "..." }, + { + "id": 1884, + "name": "defaultAdminSwapFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 1885, + "name": "AdminSwapsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of swaps with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1886, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1887, + "name": "swaps", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of swaps details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/swap.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1887 + ] + } + ] + } + } + ] + } + }, + { + "id": 1888, + "name": "AdminSwapsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The swap's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1889, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1890, + "name": "swap", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Swap details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/swap.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1890 + ] + } + ] + } + } + }, + { + "id": 1891, + "name": "AdminGetSwapsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how a list of data is paginated." + } + ] + }, + "children": [ + { + "id": 1892, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1893, + "name": "new AdminGetSwapsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1891, + "name": "AdminGetSwapsParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1894, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "50" + }, + { + "id": 1895, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1892 + ] + }, + { + "title": "Properties", + "children": [ + 1894, + 1895 + ] + } + ] + }, + { + "id": 1948, + "name": "AdminPostTaxRatesTaxRateProductTypesReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product types to add to the tax rate." + } + ] + }, + "children": [ + { + "id": 1949, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1950, + "name": "new AdminPostTaxRatesTaxRateProductTypesReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product types to add to the tax rate." + } + ] + }, + "type": { + "type": "reference", + "target": 1948, + "name": "AdminPostTaxRatesTaxRateProductTypesReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1951, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the types of products to associate with this tax rate" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1949 + ] + }, + { + "title": "Properties", + "children": [ + 1951 + ] + } + ] + }, + { + "id": 1952, + "name": "AdminPostTaxRatesTaxRateProductTypesParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1953, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1954, + "name": "new AdminPostTaxRatesTaxRateProductTypesParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1952, + "name": "AdminPostTaxRatesTaxRateProductTypesParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1955, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1956, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1953 + ] + }, + { + "title": "Properties", + "children": [ + 1955, + 1956 + ] + } + ] + }, + { + "id": 1957, + "name": "AdminPostTaxRatesTaxRateProductsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to associat with the tax rate." + } + ] + }, + "children": [ + { + "id": 1958, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1959, + "name": "new AdminPostTaxRatesTaxRateProductsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to associat with the tax rate." + } + ] + }, + "type": { + "type": "reference", + "target": 1957, + "name": "AdminPostTaxRatesTaxRateProductsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1960, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the products to associate with this tax rate" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1958 + ] + }, + { + "title": "Properties", + "children": [ + 1960 + ] + } + ] + }, + { + "id": 1961, + "name": "AdminPostTaxRatesTaxRateProductsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1962, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1963, + "name": "new AdminPostTaxRatesTaxRateProductsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1961, + "name": "AdminPostTaxRatesTaxRateProductsParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1964, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1965, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1962 + ] + }, + { + "title": "Properties", + "children": [ + 1964, + 1965 + ] + } + ] + }, + { + "id": 1966, + "name": "AdminPostTaxRatesTaxRateShippingOptionsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping options to associate with the tax rate." + } + ] + }, + "children": [ + { + "id": 1967, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1968, + "name": "new AdminPostTaxRatesTaxRateShippingOptionsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping options to associate with the tax rate." + } + ] + }, + "type": { + "type": "reference", + "target": 1966, + "name": "AdminPostTaxRatesTaxRateShippingOptionsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1969, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the shipping options to associate with this tax rate" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1967 + ] + }, + { + "title": "Properties", + "children": [ + 1969 + ] + } + ] + }, + { + "id": 1970, + "name": "AdminPostTaxRatesTaxRateShippingOptionsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1971, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1972, + "name": "new AdminPostTaxRatesTaxRateShippingOptionsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1970, + "name": "AdminPostTaxRatesTaxRateShippingOptionsParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1973, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1974, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1971 + ] + }, + { + "title": "Properties", + "children": [ + 1973, + 1974 + ] + } + ] + }, + { + "id": 1975, + "name": "AdminPostTaxRatesReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the tax rate to create." + } + ] + }, + "children": [ + { + "id": 1976, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1977, + "name": "new AdminPostTaxRatesReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the tax rate to create." + } + ] + }, + "type": { + "type": "reference", + "target": 1975, + "name": "AdminPostTaxRatesReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1978, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the tax rate." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1979, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the tax rate." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1980, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Region that the tax rate belongs to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1981, + "name": "rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The numeric rate to charge." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 1982, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the products associated with this tax rate." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1983, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the shipping options associated with this tax rate" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1984, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the types of products associated with this tax rate" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1976 + ] + }, + { + "title": "Properties", + "children": [ + 1978, + 1979, + 1980, + 1981, + 1982, + 1983, + 1984 + ] + } + ] + }, + { + "id": 1985, + "name": "AdminPostTaxRatesParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1986, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1987, + "name": "new AdminPostTaxRatesParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1985, + "name": "AdminPostTaxRatesParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1988, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1989, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1986 + ] + }, + { + "title": "Properties", + "children": [ + 1988, + 1989 + ] + } + ] + }, + { + "id": 1916, + "name": "AdminGetTaxRatesTaxRateParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1917, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1918, + "name": "new AdminGetTaxRatesTaxRateParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1916, + "name": "AdminGetTaxRatesTaxRateParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1919, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1920, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1917 + ] + }, + { + "title": "Properties", + "children": [ + 1919, + 1920 + ] + } + ] + }, + { + "id": 1896, + "name": "defaultAdminTaxRatesRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "never" + } + }, + "defaultValue": "[]" + }, { "id": 1897, "name": "defaultAdminTaxRatesFields", @@ -113701,8 +52563,2999 @@ "defaultValue": "..." }, { - "id": 1896, - "name": "defaultAdminTaxRatesRelations", + "id": 1898, + "name": "AdminTaxRatesDeleteRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 1899, + "name": "AdminTaxRatesListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of tax rates with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 1900, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1901, + "name": "tax_rates", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of tax rate details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", + "qualifiedName": "TaxRate" + }, + "name": "TaxRate", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1901 + ] + } + ] + } + } + ] + } + }, + { + "id": 1902, + "name": "AdminTaxRatesRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1903, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1904, + "name": "tax_rate", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tax rate details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/tax-rate.ts", + "qualifiedName": "TaxRate" + }, + "name": "TaxRate", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1904 + ] + } + ] + } + } + }, + { + "id": 1905, + "name": "AdminGetTaxRatesParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved tax rates." + } + ] + }, + "children": [ + { + "id": 1906, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1907, + "name": "new AdminGetTaxRatesParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1905, + "name": "AdminGetTaxRatesParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1908, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter tax rates by the IDs of their associates region." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 1909, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name to filter tax rates by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1910, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Code to filter tax rates by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1911, + "name": "rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number filters to filter tax rates' " + }, + { + "kind": "code", + "text": "`rate`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "reference", + "target": 3935, + "name": "NumericalComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 1912, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 1913, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n50\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "50" + }, + { + "id": 1914, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1915, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1906 + ] + }, + { + "title": "Properties", + "children": [ + 1908, + 1909, + 1910, + 1911, + 1912, + 1913, + 1914, + 1915 + ] + } + ] + }, + { + "id": 1921, + "name": "AdminDeleteTaxRatesTaxRateProductTypesReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product types to remove from the tax rates." + } + ] + }, + "children": [ + { + "id": 1922, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1923, + "name": "new AdminDeleteTaxRatesTaxRateProductTypesReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product types to remove from the tax rates." + } + ] + }, + "type": { + "type": "reference", + "target": 1921, + "name": "AdminDeleteTaxRatesTaxRateProductTypesReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1924, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the product types to remove their association with this tax rate." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1922 + ] + }, + { + "title": "Properties", + "children": [ + 1924 + ] + } + ] + }, + { + "id": 1925, + "name": "AdminDeleteTaxRatesTaxRateProductTypesParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1926, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1927, + "name": "new AdminDeleteTaxRatesTaxRateProductTypesParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1925, + "name": "AdminDeleteTaxRatesTaxRateProductTypesParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1928, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1929, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1926 + ] + }, + { + "title": "Properties", + "children": [ + 1928, + 1929 + ] + } + ] + }, + { + "id": 1930, + "name": "AdminDeleteTaxRatesTaxRateProductsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to remove their associated with the tax rate." + } + ] + }, + "children": [ + { + "id": 1931, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1932, + "name": "new AdminDeleteTaxRatesTaxRateProductsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the products to remove their associated with the tax rate." + } + ] + }, + "type": { + "type": "reference", + "target": 1930, + "name": "AdminDeleteTaxRatesTaxRateProductsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1933, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the products to remove their association with this tax rate." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1931 + ] + }, + { + "title": "Properties", + "children": [ + 1933 + ] + } + ] + }, + { + "id": 1934, + "name": "AdminDeleteTaxRatesTaxRateProductsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1935, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1936, + "name": "new AdminDeleteTaxRatesTaxRateProductsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1934, + "name": "AdminDeleteTaxRatesTaxRateProductsParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1937, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1938, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1935 + ] + }, + { + "title": "Properties", + "children": [ + 1937, + 1938 + ] + } + ] + }, + { + "id": 1939, + "name": "AdminDeleteTaxRatesTaxRateShippingOptionsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping options to remove their associate with the tax rate." + } + ] + }, + "children": [ + { + "id": 1940, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1941, + "name": "new AdminDeleteTaxRatesTaxRateShippingOptionsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping options to remove their associate with the tax rate." + } + ] + }, + "type": { + "type": "reference", + "target": 1939, + "name": "AdminDeleteTaxRatesTaxRateShippingOptionsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1942, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the shipping options to remove their association with this tax rate." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1940 + ] + }, + { + "title": "Properties", + "children": [ + 1942 + ] + } + ] + }, + { + "id": 1943, + "name": "AdminDeleteTaxRatesTaxRateShippingOptionsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 1944, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1945, + "name": "new AdminDeleteTaxRatesTaxRateShippingOptionsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 1943, + "name": "AdminDeleteTaxRatesTaxRateShippingOptionsParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1946, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1947, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1944 + ] + }, + { + "title": "Properties", + "children": [ + 1946, + 1947 + ] + } + ] + }, + { + "id": 1990, + "name": "AdminPostTaxRatesTaxRateReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the tax rate." + } + ] + }, + "children": [ + { + "id": 1991, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 1992, + "name": "new AdminPostTaxRatesTaxRateReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the tax rate." + } + ] + }, + "type": { + "type": "reference", + "target": 1990, + "name": "AdminPostTaxRatesTaxRateReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 1993, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the tax rate." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1994, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the tax rate." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1995, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Region that the tax rate belongs to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1996, + "name": "rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The numeric rate to charge." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 1997, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the products associated with this tax rate" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1998, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the shipping options associated with this tax rate" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1999, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the types of product types associated with this tax rate" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 1991 + ] + }, + { + "title": "Properties", + "children": [ + 1993, + 1994, + 1995, + 1996, + 1997, + 1998, + 1999 + ] + } + ] + }, + { + "id": 2000, + "name": "AdminPostTaxRatesTaxRateParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 2001, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2002, + "name": "new AdminPostTaxRatesTaxRateParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2000, + "name": "AdminPostTaxRatesTaxRateParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2003, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2004, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2001 + ] + }, + { + "title": "Properties", + "children": [ + 2003, + 2004 + ] + } + ] + }, + { + "id": 2012, + "name": "IAdminPostUploadsFileReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2013, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2014, + "name": "new IAdminPostUploadsFileReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2012, + "name": "IAdminPostUploadsFileReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2015, + "name": "originalName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2016, + "name": "path", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2013 + ] + }, + { + "title": "Properties", + "children": [ + 2015, + 2016 + ] + } + ] + }, + { + "id": 2017, + "name": "AdminDeleteUploadsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to delete." + } + ] + }, + "children": [ + { + "id": 2018, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2019, + "name": "new AdminDeleteUploadsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to delete." + } + ] + }, + "type": { + "type": "reference", + "target": 2017, + "name": "AdminDeleteUploadsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2020, + "name": "file_key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "key of the file to delete. This is obtained when you first uploaded the file, or by the file service if you used it directly." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2018 + ] + }, + { + "title": "Properties", + "children": [ + 2020 + ] + } + ] + }, + { + "id": 2021, + "name": "AdminPostUploadsDownloadUrlReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to retrieve its download URL." + } + ] + }, + "children": [ + { + "id": 2022, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2023, + "name": "new AdminPostUploadsDownloadUrlReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to retrieve its download URL." + } + ] + }, + "type": { + "type": "reference", + "target": 2021, + "name": "AdminPostUploadsDownloadUrlReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2024, + "name": "file_key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "key of the file to obtain the download link for. This is obtained when you first uploaded the file, or by the file service if you used it directly." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2022 + ] + }, + { + "title": "Properties", + "children": [ + 2024 + ] + } + ] + }, + { + "id": 2005, + "name": "AdminUploadsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of uploaded files." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2006, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2007, + "name": "uploads", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Uploaded files details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4766, + "name": "FileServiceUploadResult", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2007 + ] + } + ] + } + } + }, + { + "id": 2008, + "name": "AdminDeleteUploadsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 2009, + "name": "AdminUploadsDownloadUrlRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The download URL details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2010, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2011, + "name": "download_url", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Download URL of the file" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2011 + ] + } + ] + } + } + }, + { + "id": 2050, + "name": "AdminCreateUserRequest", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2051, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2052, + "name": "new AdminCreateUserRequest", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2050, + "name": "AdminCreateUserRequest", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2053, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The User's email." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2054, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The first name of the User." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2055, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The last name of the User." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2056, + "name": "role", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The role assigned to the user. These roles don't provide any different privileges." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/user.ts", + "qualifiedName": "UserRoles" + }, + "name": "UserRoles", + "package": "@medusajs/medusa" + } + }, + { + "id": 2057, + "name": "password", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The User's password." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2051 + ] + }, + { + "title": "Properties", + "children": [ + 2053, + 2054, + 2055, + 2056, + 2057 + ] + } + ] + }, + { + "id": 2025, + "name": "unauthenticatedUserRoutes", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 2026, + "name": "unauthenticatedUserRoutes", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2027, + "name": "app", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 2028, + "name": "AdminUserRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The user's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2029, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2030, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "User details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/user.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2030 + ] + } + ] + } + } + }, + { + "id": 2031, + "name": "AdminUsersListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of users." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2032, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2033, + "name": "users", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of users details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/user.ts", + "qualifiedName": "User" + }, + "name": "User", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2033 + ] + } + ] + } + } + }, + { + "id": 2034, + "name": "AdminDeleteUserRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 3911, + "name": "DeleteResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 2046, + "name": "AdminResetPasswordTokenRequest", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the password reset token request." + } + ] + }, + "children": [ + { + "id": 2047, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2048, + "name": "new AdminResetPasswordTokenRequest", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the password reset token request." + } + ] + }, + "type": { + "type": "reference", + "target": 2046, + "name": "AdminResetPasswordTokenRequest", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2049, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The User's email." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2047 + ] + }, + { + "title": "Properties", + "children": [ + 2049 + ] + } + ] + }, + { + "id": 2035, + "name": "payload", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2036, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2037, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2038, + "name": "user_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2039, + "name": "password", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2037, + 2038, + 2039 + ] + } + ] + } + } + }, + { + "id": 2040, + "name": "AdminResetPasswordRequest", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the password reset request." + } + ] + }, + "children": [ + { + "id": 2041, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2042, + "name": "new AdminResetPasswordRequest", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the password reset request." + } + ] + }, + "type": { + "type": "reference", + "target": 2040, + "name": "AdminResetPasswordRequest", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2043, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The User's email." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2044, + "name": "token", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The password-reset token generated when the password reset was requested." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2045, + "name": "password", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The User's new password." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2041 + ] + }, + { + "title": "Properties", + "children": [ + 2043, + 2044, + 2045 + ] + } + ] + }, + { + "id": 2058, + "name": "AdminUpdateUserRequest", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2059, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2060, + "name": "new AdminUpdateUserRequest", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2058, + "name": "AdminUpdateUserRequest", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2061, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The first name of the User." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2062, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The last name of the User." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2063, + "name": "role", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The role assigned to the user. These roles don't provide any different privileges." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/user.ts", + "qualifiedName": "UserRoles" + }, + "name": "UserRoles", + "package": "@medusajs/medusa" + } + }, + { + "id": 2064, + "name": "api_token", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The API token of the User." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2065, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional set of key-value pairs with additional information." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2059 + ] + }, + { + "title": "Properties", + "children": [ + 2061, + 2062, + 2063, + 2064, + 2065 + ] + } + ] + }, + { + "id": 2094, + "name": "LevelWithAvailability", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 4413, + "name": "InventoryLevelDTO", + "package": "@medusajs/types" + }, + { + "type": "reflection", + "declaration": { + "id": 2095, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2096, + "name": "available_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2096 + ] + } + ] + } + } + ] + } + }, + { + "id": 2097, + "name": "ResponseInventoryItem", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": 4393, + "name": "InventoryItemDTO", + "package": "@medusajs/types" + } + ], + "name": "Partial", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2098, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2099, + "name": "location_levels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory's location levels." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2094, + "name": "LevelWithAvailability", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2099 + ] + } + ] + } + } + ] + } + }, + { + "id": 2100, + "name": "VariantInventory", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2101, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2102, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the ID of the variant" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2103, + "name": "inventory", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2097, + "name": "ResponseInventoryItem", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2104, + "name": "sales_channel_availability", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Details about the variant's inventory availability in sales channels." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 2105, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2106, + "name": "channel_name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sales channel's name" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2107, + "name": "channel_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sales channel's ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2108, + "name": "available_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Available quantity in the sales channel" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2106, + 2107, + 2108 + ] + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2102, + 2103, + 2104 + ] + } + ] + } + } + }, + { + "id": 2109, + "name": "AdminGetVariantsVariantInventoryRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The variant's inventory details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2110, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2111, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product variant's inventory details." + } + ] + }, + "type": { + "type": "reference", + "target": 2100, + "name": "VariantInventory", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2111 + ] + } + ] + } + } + }, + { + "id": 2089, + "name": "AdminGetVariantParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 2090, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2091, + "name": "new AdminGetVariantParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2089, + "name": "AdminGetVariantParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 2092, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 2093, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2090 + ] + }, + { + "title": "Properties", + "children": [ + 2092, + 2093 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2066, + "name": "defaultAdminVariantRelations", "variant": "declaration", "kind": 32, "flags": { @@ -113712,10 +55565,10 @@ "type": "array", "elementType": { "type": "intrinsic", - "name": "never" + "name": "string" } }, - "defaultValue": "[]" + "defaultValue": "..." }, { "id": 2067, @@ -113744,226 +55597,1341 @@ "defaultValue": "..." }, { - "id": 2066, - "name": "defaultAdminVariantRelations", + "id": 2068, + "name": "AdminVariantsListRes", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of variants with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] }, "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 2069, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2070, + "name": "variants", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product variant details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4769, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2070 + ] + } + ] + } + } + ] + } }, { - "id": 1748, - "name": "defaultFields", + "id": 2071, + "name": "AdminVariantsRes", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product variant's details." + } + ], + "modifierTags": [ + "@interface" + ] }, "type": { - "type": "array", - "elementType": { - "type": "typeOperator", - "operator": "keyof", - "target": { + "type": "reflection", + "declaration": { + "id": 2072, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2073, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product variant's details." + } + ] + }, + "type": { + "type": "reference", + "target": 4769, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2073 + ] + } + ] + } + } + }, + { + "id": 2074, + "name": "AdminGetVariantsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved product variants." + } + ] + }, + "children": [ + { + "id": 2075, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2076, + "name": "new AdminGetVariantsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2074, + "name": "AdminGetVariantsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4772, + "name": "AdminPriceSelectionParams.constructor" + } + } + ], + "inheritedFrom": { "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", - "qualifiedName": "ShippingOption" - }, - "name": "ShippingOption", - "package": "@medusajs/medusa" + "target": 4771, + "name": "AdminPriceSelectionParams.constructor" + } + }, + { + "id": 2077, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search product variants' IDs." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2078, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20" + }, + { + "id": 2079, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 2080, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "overwrites": { + "type": "reference", + "target": 4777, + "name": "AdminPriceSelectionParams.expand" + } + }, + { + "id": 2081, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "overwrites": { + "type": "reference", + "target": 4778, + "name": "AdminPriceSelectionParams.fields" + } + }, + { + "id": 2082, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter product variants by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 2083, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Titles to filter product variants by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 2084, + "name": "inventory_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number filters to apply on product variants' " + }, + { + "kind": "code", + "text": "`inventory_quantity`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "reference", + "target": 3935, + "name": "NumericalComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 2086, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a cart ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4774, + "name": "AdminPriceSelectionParams.cart_id" + } + }, + { + "id": 2087, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a region ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4775, + "name": "AdminPriceSelectionParams.region_id" + } + }, + { + "id": 2088, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a currency code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4776, + "name": "AdminPriceSelectionParams.currency_code" + } + }, + { + "id": 2085, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a customer ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4773, + "name": "AdminPriceSelectionParams.customer_id" } } - }, - "defaultValue": "..." - }, - { - "id": 996, - "name": "defaultPaymentCollectionFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2075 + ] + }, + { + "title": "Properties", + "children": [ + 2077, + 2078, + 2079, + 2080, + 2081, + 2082, + 2083, + 2084, + 2086, + 2087, + 2088, + 2085 + ] } - }, - "defaultValue": "..." - }, - { - "id": 2341, - "name": "defaultPaymentCollectionRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4770, + "name": "AdminPriceSelectionParams", + "package": "@medusajs/medusa" } - }, - "defaultValue": "..." + ] }, { - "id": 1016, - "name": "defaultPaymentFields", + "id": 2121, + "name": "StorePostAuthReq", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 1160, - "name": "defaultProductCategoryFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 1628, - "name": "defaultRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 1860, - "name": "defaultRelationsExtended", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 1629, - "name": "defaultRelationsList", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 1663, - "name": "defaultReservationFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 1631, - "name": "defaultReturnCancelFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "Order" - }, - "name": "Order", - "package": "@medusajs/medusa" + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2122, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2123, + "name": "new StorePostAuthReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2121, + "name": "StorePostAuthReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2124, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Customer's email." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2125, + "name": "password", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Customer's password." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" } } - }, - "defaultValue": "..." + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2122 + ] + }, + { + "title": "Properties", + "children": [ + 2124, + 2125 + ] + } + ] }, { - "id": 1630, - "name": "defaultReturnCancelRelations", + "id": 2112, + "name": "StoreAuthRes", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's details." + } + ], + "modifierTags": [ + "@interface" + ] }, "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" + "type": "reflection", + "declaration": { + "id": 2113, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2114, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Customer's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2114 + ] + } + ] } + } + }, + { + "id": 2115, + "name": "StoreBearerAuthRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The access token details." + } + ], + "modifierTags": [ + "@interface" + ] }, - "defaultValue": "..." + "type": { + "type": "reflection", + "declaration": { + "id": 2116, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2117, + "name": "access_token", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Access token that can be used to send authenticated requests." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2117 + ] + } + ] + } + } + }, + { + "id": 2118, + "name": "StoreGetAuthEmailRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Details on whether the email exists." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2119, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2120, + "name": "exists", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether email exists or not." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2120 + ] + } + ] + } + } + }, + { + "id": 2141, + "name": "StorePostCartsCartShippingMethodReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping method to add to the cart." + } + ] + }, + "children": [ + { + "id": 2142, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2143, + "name": "new StorePostCartsCartShippingMethodReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the shipping method to add to the cart." + } + ] + }, + "type": { + "type": "reference", + "target": 2141, + "name": "StorePostCartsCartShippingMethodReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2144, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the shipping option to create the method from." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2145, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to hold any data that the shipping method may need to process the fulfillment of the order. This depends on the fulfillment provider you're using." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + }, + "defaultValue": "{}" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2142 + ] + }, + { + "title": "Properties", + "children": [ + 2144, + 2145 + ] + } + ] + }, + { + "id": 2146, + "name": "Item", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2147, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2148, + "name": "new Item", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2146, + "name": "Item", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2149, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2150, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity to add into the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2147 + ] + }, + { + "title": "Properties", + "children": [ + 2149, + 2150 + ] + } + ] + }, + { + "id": 2151, + "name": "StorePostCartReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the cart to be created." + } + ] + }, + "children": [ + { + "id": 2152, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2153, + "name": "new StorePostCartReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the cart to be created." + } + ] + }, + "type": { + "type": "reference", + "target": 2151, + "name": "StorePostCartReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2154, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Region to create the Cart in. Setting the cart's region can affect the pricing of the items in the cart as well as the used currency. If this parameter is not provided, the first region in the store is used by default." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2155, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The two character ISO country code to create the Cart in. Setting this parameter will set the country code of the shipping address." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2156, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product variants to generate line items from." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2146, + "name": "Item", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2157, + "name": "context", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object to provide context to the Cart. The `context` field is automatically populated with `ip` and `user_agent`" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 2158, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Sales channel to create the Cart in. The cart's sales channel affects which products can be added to the cart. If a product does not exist in the cart's sales channel, it cannot be added to the cart. If you add a publishable API key in the header of this request and specify a sales channel ID, the specified sales channel must be within the scope of the publishable API key's resources. If you add a publishable API key in the header of this request, you don't specify a sales channel ID, and the publishable API key is associated with one sales channel, that sales channel will be attached to the cart. If no sales channel is passed and no publishable API key header is passed or the publishable API key isn't associated with any sales channel, the cart will not be associated with any sales channel." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2152 + ] + }, + { + "title": "Properties", + "children": [ + 2154, + 2155, + 2156, + 2157, + 2158 + ] + } + ] + }, + { + "id": 2159, + "name": "StorePostCartsCartLineItemsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the line item to create." + } + ] + }, + "children": [ + { + "id": 2160, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2161, + "name": "new StorePostCartsCartLineItemsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the line item to create." + } + ] + }, + "type": { + "type": "reference", + "target": 2159, + "name": "StorePostCartsCartLineItemsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2162, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the Product Variant to generate the Line Item from." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2163, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the Product Variant to add to the Line Item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2164, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional key-value map with additional details about the Line Item." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2160 + ] + }, + { + "title": "Properties", + "children": [ + 2162, + 2163, + 2164 + ] + } + ] }, { "id": 2126, @@ -114009,59 +56977,1029 @@ "defaultValue": "..." }, { - "id": 2372, - "name": "defaultStoreCategoryScope", + "id": 2128, + "name": "StoreCartsRes", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's details." + } + ], + "modifierTags": [ + "@interface" + ] }, "type": { "type": "reflection", "declaration": { - "id": 2373, + "id": 2129, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 2375, - "name": "is_active", + "id": 2130, + "name": "cart", "variant": "declaration", "kind": 1024, "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cart details." + } + ] }, - "defaultValue": "true" - }, - { - "id": 2374, - "name": "is_internal", - "variant": "declaration", - "kind": 1024, - "flags": {}, "type": { - "type": "intrinsic", - "name": "boolean" - }, - "defaultValue": "false" + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "refundable_amount" + }, + { + "type": "literal", + "value": "refunded_total" + } + ] + } + ], + "name": "Omit", + "package": "typescript" + } } ], "groups": [ { "title": "Properties", "children": [ - 2375, - 2374 + 2130 ] } ] } + } + }, + { + "id": 2131, + "name": "StoreCompleteCartRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the cart is completed successfully, this will have the created order or the swap's details, based on the cart's type. Otherwise, it'll be the cart's details." + } + ], + "modifierTags": [ + "@interface" + ] }, - "defaultValue": "..." + "type": { + "type": "union", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2132, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2133, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "literal", + "value": "cart" + } + }, + { + "id": 2134, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2133, + 2134 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2135, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2136, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "literal", + "value": "order" + } + }, + { + "id": 2137, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2136, + 2137 + ] + } + ] + } + }, + { + "type": "reflection", + "declaration": { + "id": 2138, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2139, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "literal", + "value": "swap" + } + }, + { + "id": 2140, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A swap can be created when a Customer wishes to exchange Products that they have purchased with different Products. It consists of a Return of previously purchased Products and a Fulfillment of new Products. It also includes information on any additional payment or refund required based on the difference between the exchanged products." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/swap.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2139, + 2140 + ] + } + ] + } + } + ] + } + }, + { + "id": 2165, + "name": "StorePostCartsCartPaymentSessionReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment session to set." + } + ] + }, + "children": [ + { + "id": 2166, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2167, + "name": "new StorePostCartsCartPaymentSessionReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment session to set." + } + ] + }, + "type": { + "type": "reference", + "target": 2165, + "name": "StorePostCartsCartPaymentSessionReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2168, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Payment Provider." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2166 + ] + }, + { + "title": "Properties", + "children": [ + 2168 + ] + } + ] + }, + { + "id": 4779, + "name": "GiftCard", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Gift Cards are redeemable and represent a value that can be used towards the payment of an Order." + } + ] + }, + "children": [ + { + "id": 4780, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4781, + "name": "new GiftCard", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Gift Cards are redeemable and represent a value that can be used towards the payment of an Order." + } + ] + }, + "type": { + "type": "reference", + "target": 4779, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4782, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of a gift card." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4780 + ] + }, + { + "title": "Properties", + "children": [ + 4782 + ] + } + ] + }, + { + "id": 4783, + "name": "Discount", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A discount can be applied to a cart for promotional purposes." + } + ] + }, + "children": [ + { + "id": 4784, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4785, + "name": "new Discount", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A discount can be applied to a cart for promotional purposes." + } + ] + }, + "type": { + "type": "reference", + "target": 4783, + "name": "Discount", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4786, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the discount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4784 + ] + }, + { + "title": "Properties", + "children": [ + 4786 + ] + } + ] + }, + { + "id": 2169, + "name": "StorePostCartsCartReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the cart." + } + ] + }, + "children": [ + { + "id": 2170, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2171, + "name": "new StorePostCartsCartReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the cart." + } + ] + }, + "type": { + "type": "reference", + "target": 2169, + "name": "StorePostCartsCartReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2172, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Region to create the Cart in. Setting the cart's region can affect the pricing of the items in the cart as well as the used currency." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2173, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The 2 character ISO country code to create the Cart in. Setting this parameter will set the country code of the shipping address." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2174, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An email to be used on the Cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2175, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Address to be used for billing purposes." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 3942, + "name": "AddressPayload", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 2176, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Address to be used for shipping purposes." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 3942, + "name": "AddressPayload", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 2177, + "name": "gift_cards", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of Gift Card codes to add to the Cart." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4779, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2178, + "name": "discounts", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of Discount codes to add to the Cart." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4783, + "name": "Discount", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2179, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Customer to associate the Cart with." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2180, + "name": "context", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object to provide context to the Cart. The `context` field is automatically populated with `ip` and `user_agent`" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 2181, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Sales channel to create the Cart in. The cart's sales channel affects which products can be added to the cart. If a product does not exist in the cart's sales channel, it cannot be added to the cart. If you add a publishable API key in the header of this request and specify a sales channel ID, the specified sales channel must be within the scope of the publishable API key's resources." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2170 + ] + }, + { + "title": "Properties", + "children": [ + 2172, + 2173, + 2174, + 2175, + 2176, + 2177, + 2178, + 2179, + 2180, + 2181 + ] + } + ] + }, + { + "id": 2182, + "name": "StorePostCartsCartLineItemsItemReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the line item." + } + ] + }, + "children": [ + { + "id": 2183, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2184, + "name": "new StorePostCartsCartLineItemsItemReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the line item." + } + ] + }, + "type": { + "type": "reference", + "target": 2182, + "name": "StorePostCartsCartLineItemsItemReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2185, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the line item in the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2186, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional key-value map with additional details about the Line Item. If omitted, the metadata will remain unchanged.\"" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2183 + ] + }, + { + "title": "Properties", + "children": [ + 2185, + 2186 + ] + } + ] + }, + { + "id": 2187, + "name": "StorePostCartsCartPaymentSessionUpdateReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2188, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2189, + "name": "new StorePostCartsCartPaymentSessionUpdateReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2187, + "name": "StorePostCartsCartPaymentSessionUpdateReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2190, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to update the payment session with." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2188 + ] + }, + { + "title": "Properties", + "children": [ + 2190 + ] + } + ] }, { "id": 2191, @@ -114080,6 +58018,615 @@ }, "defaultValue": "[]" }, + { + "id": 2192, + "name": "allowedFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2193, + "name": "StoreCollectionsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of product collections with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 2194, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2195, + "name": "collections", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product collections details" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-collection.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2195 + ] + } + ] + } + } + ] + } + }, + { + "id": 2196, + "name": "StoreCollectionsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the product collection." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2197, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2198, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product collection details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-collection.ts", + "qualifiedName": "ProductCollection" + }, + "name": "ProductCollection", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2198 + ] + } + ] + } + } + }, + { + "id": 2199, + "name": "StoreGetCollectionsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved product collections." + } + ] + }, + "children": [ + { + "id": 2200, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2201, + "name": "new StoreGetCollectionsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2199, + "name": "StoreGetCollectionsParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2202, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Handles to filter product collections by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2203, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n10\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "10" + }, + { + "id": 2204, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 2205, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the product collections' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date" + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 2206, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the product collections' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2200 + ] + }, + { + "title": "Properties", + "children": [ + 2202, + 2203, + 2204, + 2205, + 2206 + ] + } + ] + }, + { + "id": 2226, + "name": "StorePostCustomersCustomerAddressesReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2227, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2228, + "name": "new StorePostCustomersCustomerAddressesReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2226, + "name": "StorePostCustomersCustomerAddressesReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2229, + "name": "address", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Address to add to the Customer's saved addresses." + } + ] + }, + "type": { + "type": "reference", + "target": 3956, + "name": "AddressCreatePayload", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2227 + ] + }, + { + "title": "Properties", + "children": [ + 2229 + ] + } + ] + }, + { + "id": 2230, + "name": "StorePostCustomersReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the customer to create." + } + ] + }, + "children": [ + { + "id": 2231, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2232, + "name": "new StorePostCustomersReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the customer to create." + } + ] + }, + "type": { + "type": "reference", + "target": 2230, + "name": "StorePostCustomersReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2233, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's first name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2234, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's last name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2235, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's email." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2236, + "name": "password", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's password." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2237, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's phone number." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2231 + ] + }, + { + "title": "Properties", + "children": [ + 2233, + 2234, + 2235, + 2236, + 2237 + ] + } + ] + }, + { + "id": 2207, + "name": "defaultStoreCustomersRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, { "id": 2208, "name": "defaultStoreCustomersFields", @@ -114107,8 +58654,1891 @@ "defaultValue": "..." }, { - "id": 2207, - "name": "defaultStoreCustomersRelations", + "id": 2209, + "name": "allowedStoreCustomersRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2210, + "name": "allowedStoreCustomersFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2211, + "name": "StoreCustomersRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2212, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2213, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Customer details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2213 + ] + } + ] + } + } + }, + { + "id": 2214, + "name": "StoreCustomersResetPasswordRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2215, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2216, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Customer details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "password_hash" + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2216 + ] + } + ] + } + } + }, + { + "id": 2217, + "name": "StoreCustomersListOrdersRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of the customer's orders with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 2218, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2219, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of orders details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2219 + ] + } + ] + } + } + ] + } + }, + { + "id": 2220, + "name": "StoreCustomersListPaymentMethodsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment method's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2221, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2222, + "name": "payment_methods", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the saved payment methods." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 2223, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2224, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Payment Provider where the payment method is saved." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2225, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data needed for the Payment Provider to use the saved payment method." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2224, + 2225 + ] + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2222 + ] + } + ] + } + } + }, + { + "id": 2238, + "name": "StoreGetCustomersCustomerOrdersPaginationParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how a list of data is paginated." + } + ] + }, + "children": [ + { + "id": 2239, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2240, + "name": "new StoreGetCustomersCustomerOrdersPaginationParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2238, + "name": "StoreGetCustomersCustomerOrdersPaginationParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2241, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n10\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "10" + }, + { + "id": 2242, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 2243, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2244, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2239 + ] + }, + { + "title": "Properties", + "children": [ + 2241, + 2242, + 2243, + 2244 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 2245, + "name": "StoreGetCustomersCustomerOrdersParams" + } + ] + }, + { + "id": 2245, + "name": "StoreGetCustomersCustomerOrdersParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved orders." + } + ] + }, + "children": [ + { + "id": 2246, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2247, + "name": "new StoreGetCustomersCustomerOrdersParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2245, + "name": "StoreGetCustomersCustomerOrdersParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 2240, + "name": "StoreGetCustomersCustomerOrdersPaginationParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 2239, + "name": "StoreGetCustomersCustomerOrdersPaginationParams.constructor" + } + }, + { + "id": 2262, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n10\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "10", + "inheritedFrom": { + "type": "reference", + "target": 2241, + "name": "StoreGetCustomersCustomerOrdersPaginationParams.limit" + } + }, + { + "id": 2263, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": 2242, + "name": "StoreGetCustomersCustomerOrdersPaginationParams.offset" + } + }, + { + "id": 2264, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 2243, + "name": "StoreGetCustomersCustomerOrdersPaginationParams.fields" + } + }, + { + "id": 2265, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 2244, + "name": "StoreGetCustomersCustomerOrdersPaginationParams.expand" + } + }, + { + "id": 2248, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2249, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search orders' display ID, email, shipping address's first name, customer's first name, customer's last name, and customer's phone number." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2250, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statuses to filter orders by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "OrderStatus" + }, + "name": "OrderStatus", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2251, + "name": "fulfillment_status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fulfillment statuses to filter orders by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "FulfillmentStatus" + }, + "name": "FulfillmentStatus", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2252, + "name": "payment_status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Payment statuses to filter orders by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "PaymentStatus" + }, + "name": "PaymentStatus", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2253, + "name": "display_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Display ID to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2254, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cart ID to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2255, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Email to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2256, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Region ID to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2257, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Currency code to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2258, + "name": "tax_rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tax rate to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2259, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the orders' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 2260, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the orders' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 2261, + "name": "canceled_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the orders' " + }, + { + "kind": "code", + "text": "`canceled_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2246 + ] + }, + { + "title": "Properties", + "children": [ + 2262, + 2263, + 2264, + 2265, + 2248, + 2249, + 2250, + 2251, + 2252, + 2253, + 2254, + 2255, + 2256, + 2257, + 2258, + 2259, + 2260, + 2261 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 2238, + "name": "StoreGetCustomersCustomerOrdersPaginationParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2272, + "name": "StorePostCustomersCustomerPasswordTokenReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2273, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2274, + "name": "new StorePostCustomersCustomerPasswordTokenReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2272, + "name": "StorePostCustomersCustomerPasswordTokenReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2275, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's email." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2273 + ] + }, + { + "title": "Properties", + "children": [ + 2275 + ] + } + ] + }, + { + "id": 2266, + "name": "StorePostCustomersResetPasswordReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2267, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2268, + "name": "new StorePostCustomersResetPasswordReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2266, + "name": "StorePostCustomersResetPasswordReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2269, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's email." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2270, + "name": "token", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reset password token" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2271, + "name": "password", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's password." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2267 + ] + }, + { + "title": "Properties", + "children": [ + 2269, + 2270, + 2271 + ] + } + ] + }, + { + "id": 2276, + "name": "StorePostCustomersCustomerAddressesAddressReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2277, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2278, + "name": "new StorePostCustomersCustomerAddressesAddressReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2276, + "name": "StorePostCustomersCustomerAddressesAddressReq", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3944, + "name": "AddressPayload.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3943, + "name": "AddressPayload.constructor" + } + }, + { + "id": 2279, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "First name" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3945, + "name": "AddressPayload.first_name" + } + }, + { + "id": 2280, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Last name" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3946, + "name": "AddressPayload.last_name" + } + }, + { + "id": 2281, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Phone Number" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3947, + "name": "AddressPayload.phone" + } + }, + { + "id": 2282, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional key-value map with additional details" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3948, + "name": "AddressPayload.metadata" + } + }, + { + "id": 2283, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Company" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3949, + "name": "AddressPayload.company" + } + }, + { + "id": 2284, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Address line 1" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3950, + "name": "AddressPayload.address_1" + } + }, + { + "id": 2285, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Address line 2" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3951, + "name": "AddressPayload.address_2" + } + }, + { + "id": 2286, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "City" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3952, + "name": "AddressPayload.city" + } + }, + { + "id": 2287, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The 2 character ISO code of the country in lower case" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3953, + "name": "AddressPayload.country_code" + } + }, + { + "id": 2288, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Province" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3954, + "name": "AddressPayload.province" + } + }, + { + "id": 2289, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Postal Code" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3955, + "name": "AddressPayload.postal_code" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2277 + ] + }, + { + "title": "Properties", + "children": [ + 2279, + 2280, + 2281, + 2282, + 2283, + 2284, + 2285, + 2286, + 2287, + 2288, + 2289 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3942, + "name": "AddressPayload", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2290, + "name": "StorePostCustomersCustomerReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the customer." + } + ] + }, + "children": [ + { + "id": 2291, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2292, + "name": "new StorePostCustomersCustomerReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details to update of the customer." + } + ] + }, + "type": { + "type": "reference", + "target": 2290, + "name": "StorePostCustomersCustomerReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2293, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The address to be used for billing purposes." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 3942, + "name": "AddressPayload", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 2294, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's first name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2295, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's last name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2296, + "name": "password", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's password." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2297, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's phone number." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2298, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's email." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2299, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional custom data about the customer." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2291 + ] + }, + { + "title": "Properties", + "children": [ + 2293, + 2294, + 2295, + 2296, + 2297, + 2298, + 2299 + ] + } + ] + }, + { + "id": 2300, + "name": "defaultStoreGiftCardRelations", "variant": "declaration", "kind": 32, "flags": { @@ -114150,8 +60580,377 @@ "defaultValue": "..." }, { - "id": 2300, - "name": "defaultStoreGiftCardRelations", + "id": 2302, + "name": "allowedStoreGiftCardRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2303, + "name": "allowedStoreGiftCardFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2304, + "name": "StoreGiftCardsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The gift card's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2305, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2306, + "name": "gift_card", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Gift card details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/gift-card.ts", + "qualifiedName": "GiftCard" + }, + "name": "GiftCard", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2306 + ] + } + ] + } + } + }, + { + "id": 2310, + "name": "StorePostOrderEditsOrderEditDecline", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the order edit's decline." + } + ] + }, + "children": [ + { + "id": 2311, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2312, + "name": "new StorePostOrderEditsOrderEditDecline", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the order edit's decline." + } + ] + }, + "type": { + "type": "reference", + "target": 2310, + "name": "StorePostOrderEditsOrderEditDecline", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2313, + "name": "declined_reason", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The reason for declining the Order Edit." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2311 + ] + }, + { + "title": "Properties", + "children": [ + 2313 + ] + } + ] + }, + { + "id": 2307, + "name": "StoreOrderEditsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order edit's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2308, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2309, + "name": "order_edit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Order edit details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order-edit.ts", + "qualifiedName": "OrderEdit" + }, + "name": "OrderEdit", + "package": "@medusajs/medusa" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "internal_note" + }, + { + "type": "literal", + "value": "created_by" + }, + { + "type": "literal", + "value": "confirmed_by" + }, + { + "type": "literal", + "value": "canceled_by" + } + ] + } + ], + "name": "Omit", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2309 + ] + } + ] + } + } + }, + { + "id": 2321, + "name": "StorePostCustomersCustomerAcceptClaimReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details necessary to grant order access." + } + ] + }, + "children": [ + { + "id": 2322, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2323, + "name": "new StorePostCustomersCustomerAcceptClaimReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details necessary to grant order access." + } + ] + }, + "type": { + "type": "reference", + "target": 2321, + "name": "StorePostCustomersCustomerAcceptClaimReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2324, + "name": "token", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The claim token generated by previous request to the Claim Order API Route." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2322 + ] + }, + { + "title": "Properties", + "children": [ + 2324 + ] + } + ] + }, + { + "id": 2314, + "name": "defaultStoreOrdersRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2315, + "name": "allowedStoreOrdersRelations", "variant": "declaration", "kind": 32, "flags": { @@ -114193,8 +60992,8 @@ "defaultValue": "..." }, { - "id": 2314, - "name": "defaultStoreOrdersRelations", + "id": 2317, + "name": "allowedStoreOrdersFields", "variant": "declaration", "kind": 32, "flags": { @@ -114209,6 +61008,1228 @@ }, "defaultValue": "..." }, + { + "id": 2318, + "name": "StoreOrdersRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The order's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2319, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2320, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Order details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2320 + ] + } + ] + } + } + }, + { + "id": 2325, + "name": "ShippingAddressPayload", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on the order's shipping address." + } + ] + }, + "children": [ + { + "id": 2326, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2327, + "name": "new ShippingAddressPayload", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2325, + "name": "ShippingAddressPayload", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2328, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Postal code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2326 + ] + }, + { + "title": "Properties", + "children": [ + 2328 + ] + } + ] + }, + { + "id": 2329, + "name": "StoreGetOrdersParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to narrow down the looked-up order, with configurations applied on the retrieved order." + } + ] + }, + "children": [ + { + "id": 2330, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2331, + "name": "new StoreGetOrdersParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2329, + "name": "StoreGetOrdersParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 2332, + "name": "display_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Display ID of the order." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2333, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Email of the order." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2334, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter the retrieved order by its shipping address details." + } + ] + }, + "type": { + "type": "reference", + "target": 2325, + "name": "ShippingAddressPayload", + "package": "@medusajs/medusa" + } + }, + { + "id": 2335, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 2336, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2330 + ] + }, + { + "title": "Properties", + "children": [ + 2332, + 2333, + 2334, + 2335, + 2336 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2337, + "name": "StorePostCustomersCustomerOrderClaimReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the orders to claim." + } + ] + }, + "children": [ + { + "id": 2338, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2339, + "name": "new StorePostCustomersCustomerOrderClaimReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the orders to claim." + } + ] + }, + "type": { + "type": "reference", + "target": 2337, + "name": "StorePostCustomersCustomerOrderClaimReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2340, + "name": "order_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the orders to claim" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2338 + ] + }, + { + "title": "Properties", + "children": [ + 2340 + ] + } + ] + }, + { + "id": 2348, + "name": "StorePostPaymentCollectionsBatchSessionsAuthorizeReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment sessions to authorize." + } + ] + }, + "children": [ + { + "id": 2349, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2350, + "name": "new StorePostPaymentCollectionsBatchSessionsAuthorizeReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment sessions to authorize." + } + ] + }, + "type": { + "type": "reference", + "target": 2348, + "name": "StorePostPaymentCollectionsBatchSessionsAuthorizeReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2351, + "name": "session_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of Payment Session IDs to authorize." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2349 + ] + }, + { + "title": "Properties", + "children": [ + 2351 + ] + } + ] + }, + { + "id": 2352, + "name": "StoreGetPaymentCollectionsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 2353, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2354, + "name": "new StoreGetPaymentCollectionsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2352, + "name": "StoreGetPaymentCollectionsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 2355, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 2356, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2353 + ] + }, + { + "title": "Properties", + "children": [ + 2355, + 2356 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2341, + "name": "defaultPaymentCollectionRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2342, + "name": "StorePaymentCollectionsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment collection's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2343, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2344, + "name": "payment_collection", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Payment collection's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-collection.ts", + "qualifiedName": "PaymentCollection" + }, + "name": "PaymentCollection", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2344 + ] + } + ] + } + } + }, + { + "id": 2345, + "name": "StorePaymentCollectionsSessionRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment session." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2346, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2347, + "name": "payment_session", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Payment session's details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSession" + }, + "name": "PaymentSession", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2347 + ] + } + ] + } + } + }, + { + "id": 2357, + "name": "StorePostPaymentCollectionsSessionsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2358, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2359, + "name": "new StorePostPaymentCollectionsSessionsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2357, + "name": "StorePostPaymentCollectionsSessionsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2360, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Payment Provider." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2361, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment amount" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2362, + "name": "session_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Payment Session to be updated. If no ID is provided, a new payment session is created." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2358 + ] + }, + { + "title": "Properties", + "children": [ + 2360, + 2361, + 2362 + ] + } + ] + }, + { + "id": 2363, + "name": "StorePostPaymentCollectionsBatchSessionsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment sessions to manage." + } + ] + }, + "children": [ + { + "id": 2364, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2365, + "name": "new StorePostPaymentCollectionsBatchSessionsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment sessions to manage." + } + ] + }, + "type": { + "type": "reference", + "target": 2363, + "name": "StorePostPaymentCollectionsBatchSessionsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2366, + "name": "sessions", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Payment sessions related to the Payment Collection. Existing sessions that are not added in this array will be deleted." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2357, + "name": "StorePostPaymentCollectionsSessionsReq", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2364 + ] + }, + { + "title": "Properties", + "children": [ + 2366 + ] + } + ] + }, + { + "id": 2367, + "name": "StorePaymentCollectionSessionsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment session to manage." + } + ] + }, + "children": [ + { + "id": 2368, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2369, + "name": "new StorePaymentCollectionSessionsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the payment session to manage." + } + ] + }, + "type": { + "type": "reference", + "target": 2367, + "name": "StorePaymentCollectionSessionsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2370, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Payment Provider." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2368 + ] + }, + { + "title": "Properties", + "children": [ + 2370 + ] + } + ] + }, + { + "id": 2384, + "name": "StoreGetProductCategoriesCategoryParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 2385, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2386, + "name": "new StoreGetProductCategoriesCategoryParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2384, + "name": "StoreGetProductCategoriesCategoryParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 2387, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 2388, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2385 + ] + }, + { + "title": "Properties", + "children": [ + 2387, + 2388 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2371, + "name": "defaultStoreProductCategoryRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2372, + "name": "defaultStoreCategoryScope", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2373, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2374, + "name": "is_internal", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "false" + }, + { + "id": 2375, + "name": "is_active", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "true" + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2374, + 2375 + ] + } + ] + } + }, + "defaultValue": "..." + }, { "id": 2376, "name": "defaultStoreProductCategoryFields", @@ -114227,8 +62248,1541 @@ "defaultValue": "..." }, { - "id": 2371, - "name": "defaultStoreProductCategoryRelations", + "id": 2377, + "name": "allowedStoreProductCategoryFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2378, + "name": "StoreGetProductCategoriesCategoryRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product category's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2379, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2380, + "name": "product_category", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product category details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2380 + ] + } + ] + } + } + }, + { + "id": 2381, + "name": "StoreGetProductCategoriesRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of product categories with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 2382, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2383, + "name": "product_categories", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product categories details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2383 + ] + } + ] + } + } + ] + } + }, + { + "id": 2389, + "name": "StoreGetProductCategoriesParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved product categories." + } + ] + }, + "children": [ + { + "id": 2393, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search product categories' names and handles." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2394, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Handle to filter product categories by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2395, + "name": "parent_category_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter product categories by the ID of their associated parent category." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 2396, + "name": "include_descendants_tree", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include child categories in the retrieved categories." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 2397, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).expand" + } + }, + { + "id": 2398, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).fields" + } + }, + { + "id": 2399, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).offset" + } + }, + { + "id": 2400, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of product categories returned in the list. Default is " + }, + { + "kind": "code", + "text": "`100`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).limit" + } + }, + { + "id": 2390, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2391, + "name": "new StoreGetProductCategoriesParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 2392, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 2389, + "name": "StoreGetProductCategoriesParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2390 + ] + }, + { + "title": "Properties", + "children": [ + 2393, + 2394, + 2395, + 2396, + 2397, + 2398, + 2399, + 2400 + ] + } + ], + "extendedTypes": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ] + }, + { + "id": 2401, + "name": "defaultStoreProductTagFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2402, + "name": "allowedStoreProductTagFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2403, + "name": "defaultStoreProductTagRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "never" + } + }, + "defaultValue": "[]" + }, + { + "id": 2404, + "name": "StoreProductTagsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of product tags with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 2405, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2406, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product tags details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-tag.ts", + "qualifiedName": "ProductTag" + }, + "name": "ProductTag", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2406 + ] + } + ] + } + } + ] + } + }, + { + "id": 2407, + "name": "StoreGetProductTagsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved product tags." + } + ] + }, + "children": [ + { + "id": 2408, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2409, + "name": "new StoreGetProductTagsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2407, + "name": "StoreGetProductTagsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3977, + "name": "FindPaginationParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3976, + "name": "FindPaginationParams.constructor" + } + }, + { + "id": 2410, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter product tags by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 2411, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search product tags' values." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2412, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Values to filter product tags by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 2413, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply to the product tags' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 2414, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply to the product tags' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 2415, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2416, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter product tags by the ID of their associated discount condition." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2417, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": 3978, + "name": "FindPaginationParams.offset" + } + }, + { + "id": 2418, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": 3979, + "name": "FindPaginationParams.limit" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2408 + ] + }, + { + "title": "Properties", + "children": [ + 2410, + 2411, + 2412, + 2413, + 2414, + 2415, + 2416, + 2417, + 2418 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3975, + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2419, + "name": "allowedStoreProductTypeFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2420, + "name": "defaultStoreProductTypeFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2421, + "name": "defaultStoreProductTypeRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "never" + } + }, + "defaultValue": "[]" + }, + { + "id": 2422, + "name": "StoreProductTypesListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 2423, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2424, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product types details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-type.ts", + "qualifiedName": "ProductType" + }, + "name": "ProductType", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2424 + ] + } + ] + } + } + ] + } + }, + { + "id": 2425, + "name": "StoreGetProductTypesParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved product types." + } + ] + }, + "children": [ + { + "id": 2426, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2427, + "name": "new StoreGetProductTypesParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2425, + "name": "StoreGetProductTypesParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3977, + "name": "FindPaginationParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3976, + "name": "FindPaginationParams.constructor" + } + }, + { + "id": 2428, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter product types by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 2429, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search product types' values." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2430, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Values to filter product types by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 2431, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the product types' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 2432, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the product types' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 2433, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2434, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter product types by the ID of their associated discount condition." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2435, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": 3978, + "name": "FindPaginationParams.offset" + } + }, + { + "id": 2436, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": 3979, + "name": "FindPaginationParams.limit" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2426 + ] + }, + { + "title": "Properties", + "children": [ + 2428, + 2429, + 2430, + 2431, + 2432, + 2433, + 2434, + 2435, + 2436 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3975, + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2437, + "name": "defaultStoreProductsRelations", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2438, + "name": "defaultStoreProductsFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + } + } + }, + "defaultValue": "..." + }, + { + "id": 2439, + "name": "allowedStoreProductsFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + }, + { + "id": 2440, + "name": "allowedStoreProductsRelations", "variant": "declaration", "kind": 32, "flags": { @@ -114268,49 +63822,6 @@ "kind": 65536, "flags": {}, "children": [ - { - "id": 2453, - "name": "collection", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2454, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2455, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2455 - ] - } - ] - } - }, - "defaultValue": "..." - }, { "id": 2443, "name": "fields", @@ -114378,6 +63889,135 @@ }, "defaultValue": "..." }, + { + "id": 2447, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2448, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2449, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2449 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 2450, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2451, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2452, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2452 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 2453, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2454, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2455, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2455 + ] + } + ] + } + }, + "defaultValue": "..." + }, { "id": 2456, "name": "options", @@ -114465,178 +64105,6 @@ }, "defaultValue": "..." }, - { - "id": 2468, - "name": "profile", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2469, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2470, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2470 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 2471, - "name": "sales_channels", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2472, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2473, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2473 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 2447, - "name": "tags", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2448, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2449, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2449 - ] - } - ] - } - }, - "defaultValue": "..." - }, - { - "id": 2450, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2451, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 2452, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 2452 - ] - } - ] - } - }, - "defaultValue": "..." - }, { "id": 2462, "name": "variants", @@ -114723,21 +64191,107 @@ } }, "defaultValue": "..." + }, + { + "id": 2468, + "name": "profile", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2469, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2470, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2470 + ] + } + ] + } + }, + "defaultValue": "..." + }, + { + "id": 2471, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2472, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2473, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "defaultValue": "..." + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2473 + ] + } + ] + } + }, + "defaultValue": "..." } ], "groups": [ { "title": "Properties", "children": [ - 2453, 2443, 2444, - 2456, - 2468, - 2471, 2447, 2450, - 2462 + 2453, + 2456, + 2462, + 2468, + 2471 ] } ] @@ -114746,102 +64300,1469 @@ "defaultValue": "..." }, { - "id": 2401, - "name": "defaultStoreProductTagFields", + "id": 2474, + "name": "StoreProductsRes", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] }, "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" + "type": "reflection", + "declaration": { + "id": 2475, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2476, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product details." + } + ] + }, + "type": { + "type": "reference", + "target": 4569, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2476 + ] + } + ] } - }, - "defaultValue": "..." + } }, { - "id": 2403, - "name": "defaultStoreProductTagRelations", + "id": 2477, + "name": "StorePostSearchRes", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of search results." + } + ], + "modifierTags": [ + "@interface" + ] }, "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "never" - } - }, - "defaultValue": "[]" - }, - { - "id": 2420, - "name": "defaultStoreProductTypeFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "..." - }, - { - "id": 2421, - "name": "defaultStoreProductTypeRelations", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "never" - } - }, - "defaultValue": "[]" - }, - { - "id": 2438, - "name": "defaultStoreProductsFields", - "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true - }, - "type": { - "type": "array", - "elementType": { - "type": "typeOperator", - "operator": "keyof", - "target": { + "type": "intersection", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 2478, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2479, + "name": "hits", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Array of search results. The format of the items depends on the search engine installed on the Medusa backend." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2479 + ] + } + ] + } + }, + { "type": "reference", "target": { - "sourceFileName": "../../../packages/medusa/src/models/product.ts", - "qualifiedName": "Product" + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" }, - "name": "Product", - "package": "@medusajs/medusa" + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" } - } - }, - "defaultValue": "..." + ] + } }, { - "id": 2437, - "name": "defaultStoreProductsRelations", + "id": 2480, + "name": "StoreProductsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of products with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3907, + "name": "PaginatedResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 2481, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2482, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of products details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4569, + "name": "PricedProduct", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2482 + ] + } + ] + } + } + ] + } + }, + { + "id": 2483, + "name": "StoreGetProductsPaginationParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how a list of data is paginated." + } + ] + }, + "children": [ + { + "id": 2484, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2485, + "name": "new StoreGetProductsPaginationParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2483, + "name": "StoreGetProductsPaginationParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4789, + "name": "PriceSelectionParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4788, + "name": "PriceSelectionParams.constructor" + } + }, + { + "id": 2486, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 2487, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n100\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "100" + }, + { + "id": 2488, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2492, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4793, + "name": "PriceSelectionParams.expand" + } + }, + { + "id": 2493, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4794, + "name": "PriceSelectionParams.fields" + } + }, + { + "id": 2489, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a cart ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4790, + "name": "PriceSelectionParams.cart_id" + } + }, + { + "id": 2490, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a region ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4791, + "name": "PriceSelectionParams.region_id" + } + }, + { + "id": 2491, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a currency code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4792, + "name": "PriceSelectionParams.currency_code" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2484 + ] + }, + { + "title": "Properties", + "children": [ + 2486, + 2487, + 2488, + 2492, + 2493, + 2489, + 2490, + 2491 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4787, + "name": "PriceSelectionParams", + "package": "@medusajs/medusa" + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 2494, + "name": "StoreGetProductsParams" + } + ] + }, + { + "id": 2494, + "name": "StoreGetProductsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved products." + } + ] + }, + "children": [ + { + "id": 2495, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2496, + "name": "new StoreGetProductsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2494, + "name": "StoreGetProductsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 2485, + "name": "StoreGetProductsPaginationParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 2484, + "name": "StoreGetProductsPaginationParams.constructor" + } + }, + { + "id": 2511, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": 2486, + "name": "StoreGetProductsPaginationParams.offset" + } + }, + { + "id": 2512, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n100\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "100", + "inheritedFrom": { + "type": "reference", + "target": 2487, + "name": "StoreGetProductsPaginationParams.limit" + } + }, + { + "id": 2513, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 2488, + "name": "StoreGetProductsPaginationParams.order" + } + }, + { + "id": 2497, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter products by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 2498, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search products' title, description, variants' title and sku, and collections' title." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2499, + "name": "collection_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated product collection's ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2500, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated tags' value." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2501, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Title to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2502, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2503, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Handle to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2504, + "name": "is_giftcard", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by whether they're gift cards." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 2505, + "name": "type_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated product type's ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2506, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated sales channels' ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2507, + "name": "category_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated product category's ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2508, + "name": "include_category_children", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include product category children in the response." + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "text", + "text": "product_categories" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 2509, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the products' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 2510, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the products' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 2517, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 2492, + "name": "StoreGetProductsPaginationParams.expand" + } + }, + { + "id": 2518, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 2493, + "name": "StoreGetProductsPaginationParams.fields" + } + }, + { + "id": 2514, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a cart ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 2489, + "name": "StoreGetProductsPaginationParams.cart_id" + } + }, + { + "id": 2515, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a region ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 2490, + "name": "StoreGetProductsPaginationParams.region_id" + } + }, + { + "id": 2516, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a currency code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 2491, + "name": "StoreGetProductsPaginationParams.currency_code" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2495 + ] + }, + { + "title": "Properties", + "children": [ + 2511, + 2512, + 2513, + 2497, + 2498, + 2499, + 2500, + 2501, + 2502, + 2503, + 2504, + 2505, + 2506, + 2507, + 2508, + 2509, + 2510, + 2517, + 2518, + 2514, + 2515, + 2516 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 2483, + "name": "StoreGetProductsPaginationParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2519, + "name": "StorePostSearchReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2520, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2521, + "name": "new StorePostSearchReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2519, + "name": "StorePostSearchReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2522, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The search query." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2523, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of products to skip when retrieving the products." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2524, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of products returned." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2525, + "name": "filter", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Pass filters based on the search service." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2520 + ] + }, + { + "title": "Properties", + "children": [ + 2522, + 2523, + 2524, + 2525 + ] + } + ] + }, + { + "id": 2534, + "name": "StoreGetRegionsRegionParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 2535, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2536, + "name": "new StoreGetRegionsRegionParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2534, + "name": "StoreGetRegionsRegionParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 2537, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 2538, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2535 + ] + }, + { + "title": "Properties", + "children": [ + 2537, + 2538 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2526, + "name": "defaultStoreRegionRelations", "variant": "declaration", "kind": 32, "flags": { @@ -114874,21 +65795,409 @@ "defaultValue": "..." }, { - "id": 2526, - "name": "defaultStoreRegionRelations", + "id": 2528, + "name": "StoreRegionsListRes", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of regions with pagination fields." + } + ], + "modifierTags": [ + "@interface" + ] }, "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 4425, + "name": "PaginatedResponse", + "package": "@medusajs/types" + }, + { + "type": "reflection", + "declaration": { + "id": 2529, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2530, + "name": "regions", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of regions details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/region.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2530 + ] + } + ] + } + } + ] + } + }, + { + "id": 2531, + "name": "StoreRegionsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's details." + } + ], + "modifierTags": [ + "@interface" + ] }, - "defaultValue": "..." + "type": { + "type": "reflection", + "declaration": { + "id": 2532, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2533, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Region details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/region.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2533 + ] + } + ] + } + } + }, + { + "id": 2539, + "name": "StoreGetRegionsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 2543, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 2544, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 2545, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).expand" + } + }, + { + "id": 2546, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).fields" + } + }, + { + "id": 2547, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).offset" + } + }, + { + "id": 2548, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20", + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).limit" + } + }, + { + "id": 2540, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2541, + "name": "new StoreGetRegionsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 2542, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 2539, + "name": "StoreGetRegionsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "extendedFindParamsMixin({\n limit: 100,\n offset: 0,\n}).constructor" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2540 + ] + }, + { + "title": "Properties", + "children": [ + 2543, + 2544, + 2545, + 2546, + 2547, + 2548 + ] + } + ], + "extendedTypes": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "typeArguments": [ + { + "type": "intrinsic", + "name": "this" + } + ], + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ] }, { "id": 2549, @@ -114943,38 +66252,1115 @@ "defaultValue": "..." }, { - "id": 2579, - "name": "defaultStoreSwapFields", + "id": 2551, + "name": "StoreReturnReasonsListRes", "variant": "declaration", - "kind": 32, - "flags": { - "isConst": true + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of return reasons." + } + ], + "modifierTags": [ + "@interface" + ] }, "type": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": "select" - }, - "objectType": { - "type": "reference", - "target": 3847, - "typeArguments": [ + "type": "reflection", + "declaration": { + "id": 2552, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/swap.ts", - "qualifiedName": "Swap" + "id": 2553, + "name": "return_reasons", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of return reasons details." + } + ] }, - "name": "Swap", - "package": "@medusajs/medusa" + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/return-reason.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } } ], - "name": "FindConfig", - "package": "@medusajs/medusa" + "groups": [ + { + "title": "Properties", + "children": [ + 2553 + ] + } + ] } + } + }, + { + "id": 2554, + "name": "StoreReturnReasonsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return reason's details." + } + ], + "modifierTags": [ + "@interface" + ] }, - "defaultValue": "..." + "type": { + "type": "reflection", + "declaration": { + "id": 2555, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2556, + "name": "return_reason", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return reason details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/return-reason.ts", + "qualifiedName": "ReturnReason" + }, + "name": "ReturnReason", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2556 + ] + } + ] + } + } + }, + { + "id": 4802, + "name": "ReturnShipping", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4803, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4804, + "name": "new ReturnShipping", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4802, + "name": "ReturnShipping", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4805, + "name": "option_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Shipping Option to create the Shipping Method from." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4803 + ] + }, + { + "title": "Properties", + "children": [ + 4805 + ] + } + ] + }, + { + "id": 4795, + "name": "Item", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4796, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4797, + "name": "new Item", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4795, + "name": "Item", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4798, + "name": "item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the line item to return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4799, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity to return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4800, + "name": "reason_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the return reason. Return reasons can be retrieved from the List Return Reasons API Route." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4801, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A note to add to the item returned." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4796 + ] + }, + { + "title": "Properties", + "children": [ + 4798, + 4799, + 4800, + 4801 + ] + } + ] + }, + { + "id": 2560, + "name": "StorePostReturnsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the return to create." + } + ] + }, + "children": [ + { + "id": 2561, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2562, + "name": "new StorePostReturnsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the return to create." + } + ] + }, + "type": { + "type": "reference", + "target": 2560, + "name": "StorePostReturnsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2563, + "name": "order_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Order to create the return for." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2564, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The items to include in the return." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4795, + "name": "Item", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2565, + "name": "return_shipping", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return shipping method used to return the items. If provided, a fulfillment is automatically created for the return." + } + ] + }, + "type": { + "type": "reference", + "target": 4802, + "name": "ReturnShipping", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2561 + ] + }, + { + "title": "Properties", + "children": [ + 2563, + 2564, + 2565 + ] + } + ] + }, + { + "id": 2557, + "name": "StoreReturnsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The return's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2558, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2559, + "name": "return", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Return details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/return.ts", + "qualifiedName": "Return" + }, + "name": "Return", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2559 + ] + } + ] + } + } + }, + { + "id": 2566, + "name": "StoreShippingOptionsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of shipping options." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2567, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2568, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of shipping options details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4806, + "name": "PricedShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2568 + ] + } + ] + } + } + }, + { + "id": 2569, + "name": "StoreCartShippingOptionsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2570, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2571, + "name": "shipping_options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of shipping options details." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4806, + "name": "PricedShippingOption", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2571 + ] + } + ] + } + } + }, + { + "id": 2572, + "name": "StoreGetShippingOptionsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on the retrieved shipping options." + } + ] + }, + "children": [ + { + "id": 2573, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2574, + "name": "new StoreGetShippingOptionsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2572, + "name": "StoreGetShippingOptionsParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2575, + "name": "product_ids", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product ID that is used to filter shipping options by whether they can be used to ship that product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2576, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter the shipping options by the ID of their associated region." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2577, + "name": "is_return", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter the shipping options by whether they're return shipping options." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2573 + ] + }, + { + "title": "Properties", + "children": [ + 2575, + 2576, + 2577 + ] + } + ] + }, + { + "id": 4807, + "name": "Item", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4808, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4809, + "name": "new Item", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4807, + "name": "Item", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4810, + "name": "item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the order's line item to return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4811, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity to return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4812, + "name": "reason_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the reason of this return. Return reasons can be retrieved from the List Return Reasons API Route." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4813, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The note to add to the item being swapped." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4808 + ] + }, + { + "title": "Properties", + "children": [ + 4810, + 4811, + 4812, + 4813 + ] + } + ] + }, + { + "id": 4814, + "name": "AdditionalItem", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4815, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4816, + "name": "new AdditionalItem", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4814, + "name": "AdditionalItem", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4817, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4818, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4815 + ] + }, + { + "title": "Properties", + "children": [ + 4817, + 4818 + ] + } + ] + }, + { + "id": 2583, + "name": "StorePostSwapsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the swap to create." + } + ] + }, + "children": [ + { + "id": 2584, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2585, + "name": "new StorePostSwapsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the swap to create." + } + ] + }, + "type": { + "type": "reference", + "target": 2583, + "name": "StorePostSwapsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 2586, + "name": "order_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Order to create the Swap for." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2587, + "name": "return_items", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The items to include in the Return." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4807, + "name": "Item", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2588, + "name": "additional_items", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The items to exchange the returned items with." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4814, + "name": "AdditionalItem", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 2589, + "name": "return_shipping_option", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Shipping Option to create the Shipping Method from." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2584 + ] + }, + { + "title": "Properties", + "children": [ + 2586, + 2587, + 2588, + 2589 + ] + } + ] }, { "id": 2578, @@ -114993,6 +67379,321 @@ }, "defaultValue": "..." }, + { + "id": 2579, + "name": "defaultStoreSwapFields", + "variant": "declaration", + "kind": 32, + "flags": { + "isConst": true + }, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "select" + }, + "objectType": { + "type": "reference", + "target": 3854, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/swap.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + ], + "name": "FindConfig", + "package": "@medusajs/medusa" + } + }, + "defaultValue": "..." + }, + { + "id": 2580, + "name": "StoreSwapsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The swap's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2581, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2582, + "name": "swap", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Swap details." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/swap.ts", + "qualifiedName": "Swap" + }, + "name": "Swap", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2582 + ] + } + ] + } + } + }, + { + "id": 2598, + "name": "StoreGetVariantsVariantParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context to apply on retrieved prices." + } + ] + }, + "children": [ + { + "id": 2599, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2600, + "name": "new StoreGetVariantsVariantParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2598, + "name": "StoreGetVariantsVariantParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4789, + "name": "PriceSelectionParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4788, + "name": "PriceSelectionParams.constructor" + } + }, + { + "id": 2601, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2605, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4793, + "name": "PriceSelectionParams.expand" + } + }, + { + "id": 2606, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4794, + "name": "PriceSelectionParams.fields" + } + }, + { + "id": 2602, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a cart ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4790, + "name": "PriceSelectionParams.cart_id" + } + }, + { + "id": 2603, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a region ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4791, + "name": "PriceSelectionParams.region_id" + } + }, + { + "id": 2604, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a currency code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4792, + "name": "PriceSelectionParams.currency_code" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2599 + ] + }, + { + "title": "Properties", + "children": [ + 2601, + 2605, + 2606, + 2602, + 2603, + 2604 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4787, + "name": "PriceSelectionParams", + "package": "@medusajs/medusa" + } + ] + }, { "id": 2590, "name": "defaultStoreVariantRelations", @@ -115011,8 +67712,8 @@ "defaultValue": "..." }, { - "id": 732, - "name": "filterableAdminOrdersFields", + "id": 2591, + "name": "allowedStoreVariantRelations", "variant": "declaration", "kind": 32, "flags": { @@ -115028,7 +67729,29641 @@ "defaultValue": "..." }, { - "id": 3797, + "id": 2592, + "name": "StoreVariantsRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product variant's details." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2593, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2594, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Product variant description." + } + ] + }, + "type": { + "type": "reference", + "target": 4769, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2594 + ] + } + ] + } + } + }, + { + "id": 2595, + "name": "StoreVariantsListRes", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of product variants." + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2596, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2597, + "name": "variants", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of product variant descriptions." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4769, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2597 + ] + } + ] + } + } + }, + { + "id": 2607, + "name": "StoreGetVariantsParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters used to filter and configure the pagination of the retrieved product variants." + } + ] + }, + "children": [ + { + "id": 2608, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 2609, + "name": "new StoreGetVariantsParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 2607, + "name": "StoreGetVariantsParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4789, + "name": "PriceSelectionParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4788, + "name": "PriceSelectionParams.constructor" + } + }, + { + "id": 2610, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n100\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "100" + }, + { + "id": 2611, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 2612, + "name": "ids", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID to filter the product variants by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2613, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter product variants by the ID of their associated sales channel." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2614, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter product variants by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 2615, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Titles to filter product variants by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 2616, + "name": "inventory_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Number filters to apply on the product variants' " + }, + { + "kind": "code", + "text": "`inventory_quantity`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "reference", + "target": 3935, + "name": "NumericalComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 2620, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4793, + "name": "PriceSelectionParams.expand" + } + }, + { + "id": 2621, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4794, + "name": "PriceSelectionParams.fields" + } + }, + { + "id": 2617, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a cart ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4790, + "name": "PriceSelectionParams.cart_id" + } + }, + { + "id": 2618, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a region ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4791, + "name": "PriceSelectionParams.region_id" + } + }, + { + "id": 2619, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a currency code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4792, + "name": "PriceSelectionParams.currency_code" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2608 + ] + }, + { + "title": "Properties", + "children": [ + 2610, + 2611, + 2612, + 2613, + 2614, + 2615, + 2616, + 2620, + 2621, + 2617, + 2618, + 2619 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4787, + "name": "PriceSelectionParams", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2704, + "name": "IBatchJobStrategy", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2705, + "name": "prepareBatchJobForProcessing", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2706, + "name": "prepareBatchJobForProcessing", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Method for preparing a batch job for processing" + } + ] + }, + "parameters": [ + { + "id": 2707, + "name": "batchJobEntity", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3814, + "name": "CreateBatchJobInput", + "package": "@medusajs/medusa" + } + }, + { + "id": 2708, + "name": "req", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", + "qualifiedName": "__global.Express.Request" + }, + "name": "Request", + "package": "@types/express-serve-static-core", + "qualifiedName": "__global.Express.Request" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3814, + "name": "CreateBatchJobInput", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2709, + "name": "preProcessBatchJob", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2710, + "name": "preProcessBatchJob", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Method for pre-processing a batch job" + } + ] + }, + "parameters": [ + { + "id": 2711, + "name": "batchJobId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2712, + "name": "processJob", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2713, + "name": "processJob", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Method does the actual processing of the job. Should report back on the progress of the operation." + } + ] + }, + "parameters": [ + { + "id": 2714, + "name": "batchJobId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2715, + "name": "buildTemplate", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2716, + "name": "buildTemplate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Builds and returns a template file that can be downloaded and filled in" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2717, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 2718, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 2719, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 2720, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + } + }, + { + "id": 2721, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 2722, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 2723, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 2724, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2725, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2726, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + } + }, + { + "id": 2727, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2728, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2729, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2730, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2731, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2731 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + }, + { + "id": 2732, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2733, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 2734, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 2735, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 2736, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2737, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2738, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2739, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 2740, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 2741, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2742, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2743, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 2744, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2745, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2746, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2747, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2717, + 2718, + 2721, + 2722, + 2723 + ] + }, + { + "title": "Accessors", + "children": [ + 2719 + ] + }, + { + "title": "Methods", + "children": [ + 2705, + 2709, + 2712, + 2715, + 2724, + 2727, + 2732 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 2748, + "name": "AbstractBatchJobStrategy" + } + ] + }, + { + "id": 2748, + "name": "AbstractBatchJobStrategy", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 2749, + "name": "_isBatchJobStrategy", + "variant": "declaration", + "kind": 1024, + "flags": { + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "true" + }, + { + "id": 2750, + "name": "identifier", + "variant": "declaration", + "kind": 1024, + "flags": { + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2751, + "name": "batchType", + "variant": "declaration", + "kind": 1024, + "flags": { + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2760, + "name": "batchJobService_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isAbstract": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/services/batch-job.ts", + "qualifiedName": "BatchJobService" + }, + "name": "BatchJobService", + "package": "@medusajs/medusa" + } + }, + { + "id": 2752, + "name": "isBatchJobStrategy", + "variant": "declaration", + "kind": 2048, + "flags": { + "isStatic": true + }, + "signatures": [ + { + "id": 2753, + "name": "isBatchJobStrategy", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2754, + "name": "object", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "predicate", + "name": "object", + "asserts": false, + "targetType": { + "type": "reference", + "target": 2704, + "name": "IBatchJobStrategy", + "package": "@medusajs/medusa" + } + } + } + ] + }, + { + "id": 2761, + "name": "prepareBatchJobForProcessing", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2762, + "name": "prepareBatchJobForProcessing", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Method for preparing a batch job for processing" + } + ] + }, + "parameters": [ + { + "id": 2763, + "name": "batchJob", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3814, + "name": "CreateBatchJobInput", + "package": "@medusajs/medusa" + } + }, + { + "id": 2764, + "name": "req", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", + "qualifiedName": "__global.Express.Request" + }, + "name": "Request", + "package": "@types/express-serve-static-core", + "qualifiedName": "__global.Express.Request" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3814, + "name": "CreateBatchJobInput", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2706, + "name": "IBatchJobStrategy.prepareBatchJobForProcessing" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2705, + "name": "IBatchJobStrategy.prepareBatchJobForProcessing" + } + }, + { + "id": 2765, + "name": "preProcessBatchJob", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true + }, + "signatures": [ + { + "id": 2766, + "name": "preProcessBatchJob", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Method for pre-processing a batch job" + } + ] + }, + "parameters": [ + { + "id": 2767, + "name": "batchJobId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2710, + "name": "IBatchJobStrategy.preProcessBatchJob" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2709, + "name": "IBatchJobStrategy.preProcessBatchJob" + } + }, + { + "id": 2768, + "name": "processJob", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 2769, + "name": "processJob", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Method does the actual processing of the job. Should report back on the progress of the operation." + } + ] + }, + "parameters": [ + { + "id": 2770, + "name": "batchJobId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2713, + "name": "IBatchJobStrategy.processJob" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2712, + "name": "IBatchJobStrategy.processJob" + } + }, + { + "id": 2771, + "name": "buildTemplate", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 2772, + "name": "buildTemplate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Builds and returns a template file that can be downloaded and filled in" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2716, + "name": "IBatchJobStrategy.buildTemplate" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2715, + "name": "IBatchJobStrategy.buildTemplate" + } + }, + { + "id": 2773, + "name": "shouldRetryOnProcessingError", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2774, + "name": "shouldRetryOnProcessingError", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2775, + "name": "batchJob", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Batch Job indicates an asynchronus task stored in the Medusa backend. Its status determines whether it has been executed or not." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/batch-job.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" + } + }, + { + "id": 2776, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "boolean" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2777, + "name": "handleProcessingError", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2778, + "name": "handleProcessingError", + "variant": "signature", + "kind": 4096, + "flags": {}, + "typeParameter": [ + { + "id": 2779, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 2780, + "name": "batchJobId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2781, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 2782, + "name": "result", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2779, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2783, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + }, + "implementationOf": { + "type": "reference", + "target": 2717, + "name": "IBatchJobStrategy.manager_" + } + }, + { + "id": 2784, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + }, + "implementationOf": { + "type": "reference", + "target": 2718, + "name": "IBatchJobStrategy.transactionManager_" + } + }, + { + "id": 2785, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 2786, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "IBatchJobStrategy.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + }, + "implementationOf": { + "type": "reference", + "target": 2719, + "name": "IBatchJobStrategy.activeManager_" + } + }, + { + "id": 2755, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2756, + "name": "new AbstractBatchJobStrategy", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 2757, + "name": "__container__", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 2758, + "name": "__configModule__", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 2759, + "name": "__moduleDeclaration__", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 2748, + "name": "AbstractBatchJobStrategy", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3769, + "name": "TransactionBaseService.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3768, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 2787, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + }, + "implementationOf": { + "type": "reference", + "target": 2721, + "name": "IBatchJobStrategy.__container__" + } + }, + { + "id": 2788, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + }, + "implementationOf": { + "type": "reference", + "target": 2722, + "name": "IBatchJobStrategy.__configModule__" + } + }, + { + "id": 2789, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + }, + "implementationOf": { + "type": "reference", + "target": 2723, + "name": "IBatchJobStrategy.__moduleDeclaration__" + } + }, + { + "id": 2790, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2791, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2792, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + }, + "implementationOf": { + "type": "reference", + "target": 2725, + "name": "IBatchJobStrategy.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + }, + "implementationOf": { + "type": "reference", + "target": 2724, + "name": "IBatchJobStrategy.withTransaction" + } + }, + { + "id": 2793, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2794, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2795, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2796, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2797, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2797 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + }, + "implementationOf": { + "type": "reference", + "target": 2728, + "name": "IBatchJobStrategy.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + }, + "implementationOf": { + "type": "reference", + "target": 2727, + "name": "IBatchJobStrategy.shouldRetryTransaction_" + } + }, + { + "id": 2798, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2799, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 2800, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 2801, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 2802, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2803, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2804, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2805, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 2806, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 2807, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2808, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2809, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 2810, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2811, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2812, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2813, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + }, + "implementationOf": { + "type": "reference", + "target": 2733, + "name": "IBatchJobStrategy.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + }, + "implementationOf": { + "type": "reference", + "target": 2732, + "name": "IBatchJobStrategy.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2755 + ] + }, + { + "title": "Properties", + "children": [ + 2749, + 2750, + 2751, + 2760, + 2783, + 2784, + 2787, + 2788, + 2789 + ] + }, + { + "title": "Accessors", + "children": [ + 2785 + ] + }, + { + "title": "Methods", + "children": [ + 2752, + 2761, + 2765, + 2768, + 2771, + 2773, + 2777, + 2790, + 2793, + 2798 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 2704, + "name": "IBatchJobStrategy", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2814, + "name": "CartCompletionResponse", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2815, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2816, + "name": "response_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The response code for the completion request" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2817, + "name": "response_body", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The response body for the completion request" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2816, + 2817 + ] + } + ] + } + } + }, + { + "id": 2818, + "name": "ICartCompletionStrategy", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2819, + "name": "complete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2820, + "name": "complete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Takes a cart id and completes the cart. This for example takes place when\ncreating an order or confirming a swap." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the response for the completion request" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2821, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the id of the Cart to complete." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2822, + "name": "idempotencyKey", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the idempotency key for the request" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/idempotency-key.ts", + "qualifiedName": "IdempotencyKey" + }, + "name": "IdempotencyKey", + "package": "@medusajs/medusa" + } + }, + { + "id": 2823, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the request context for the completion request" + } + ] + }, + "type": { + "type": "reference", + "target": 4851, + "name": "RequestContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2814, + "name": "CartCompletionResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 2819 + ] + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 2824, + "name": "AbstractCartCompletionStrategy" + } + ] + }, + { + "id": 2824, + "name": "AbstractCartCompletionStrategy", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 2825, + "name": "_isCartCompletionStrategy", + "variant": "declaration", + "kind": 1024, + "flags": { + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "true" + }, + { + "id": 2826, + "name": "isCartCompletionStrategy", + "variant": "declaration", + "kind": 2048, + "flags": { + "isStatic": true + }, + "signatures": [ + { + "id": 2827, + "name": "isCartCompletionStrategy", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2828, + "name": "object", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "predicate", + "name": "object", + "asserts": false, + "targetType": { + "type": "reference", + "target": 2818, + "name": "ICartCompletionStrategy", + "package": "@medusajs/medusa" + } + } + } + ] + }, + { + "id": 2834, + "name": "complete", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 2835, + "name": "complete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Takes a cart id and completes the cart. This for example takes place when\ncreating an order or confirming a swap." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the response for the completion request" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2836, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the id of the Cart to complete." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2837, + "name": "idempotencyKey", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Idempotency Key is used to continue a process in case of any failure that might occur." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/idempotency-key.ts", + "qualifiedName": "IdempotencyKey" + }, + "name": "IdempotencyKey", + "package": "@medusajs/medusa" + } + }, + { + "id": 2838, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the request context for the completion request" + } + ] + }, + "type": { + "type": "reference", + "target": 4851, + "name": "RequestContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2814, + "name": "CartCompletionResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2820, + "name": "ICartCompletionStrategy.complete" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2819, + "name": "ICartCompletionStrategy.complete" + } + }, + { + "id": 2839, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 2840, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 2841, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 2842, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + } + }, + { + "id": 2829, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2830, + "name": "new AbstractCartCompletionStrategy", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 2831, + "name": "__container__", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 2832, + "name": "__configModule__", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 2833, + "name": "__moduleDeclaration__", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 2824, + "name": "AbstractCartCompletionStrategy", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3769, + "name": "TransactionBaseService.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3768, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 2843, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 2844, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 2845, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 2846, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2847, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2848, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + } + }, + { + "id": 2849, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2850, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2851, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2852, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2853, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2853 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + }, + { + "id": 2854, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2855, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 2856, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 2857, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 2858, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2859, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2860, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2861, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 2862, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 2863, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2864, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2865, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 2866, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2867, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2868, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2869, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2829 + ] + }, + { + "title": "Properties", + "children": [ + 2825, + 2839, + 2840, + 2843, + 2844, + 2845 + ] + }, + { + "title": "Accessors", + "children": [ + 2841 + ] + }, + { + "title": "Methods", + "children": [ + 2826, + 2834, + 2846, + 2849, + 2854 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 2818, + "name": "ICartCompletionStrategy", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 2870, + "name": "IFileService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\nA file service class is defined in a TypeScript or JavaScript file that’s created in the " + }, + { + "kind": "code", + "text": "`src/services`" + }, + { + "kind": "text", + "text": " directory.\nThe class must extend the " + }, + { + "kind": "code", + "text": "`AbstractFileService`" + }, + { + "kind": "text", + "text": " class imported from the " + }, + { + "kind": "code", + "text": "`@medusajs/medusa`" + }, + { + "kind": "text", + "text": " package.\n\nBased on services’ naming conventions, the file’s name should be the slug version of the file service’s name\nwithout " + }, + { + "kind": "code", + "text": "`service`" + }, + { + "kind": "text", + "text": ", and the class’s name should be the pascal case of the file service’s name following by " + }, + { + "kind": "code", + "text": "`Service`" + }, + { + "kind": "text", + "text": ".\n\nFor example, create the file " + }, + { + "kind": "code", + "text": "`src/services/local-file.ts`" + }, + { + "kind": "text", + "text": " with the following content:\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/services/local-file.ts\"\nimport { AbstractFileService } from \"@medusajs/medusa\"\nimport {\n DeleteFileType,\n FileServiceGetUploadStreamResult,\n FileServiceUploadResult,\n GetUploadedFileType,\n UploadStreamDescriptorType,\n} from \"@medusajs/types\"\n\nclass LocalFileService extends AbstractFileService {\n async upload(\n fileData: Express.Multer.File\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n async uploadProtected(\n fileData: Express.Multer.File\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n async delete(fileData: DeleteFileType): Promise {\n throw new Error(\"Method not implemented.\")\n }\n async getUploadStreamDescriptor(\n fileData: UploadStreamDescriptorType\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n async getDownloadStream(\n fileData: GetUploadedFileType\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n async getPresignedDownloadUrl(\n fileData: GetUploadedFileType\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n}\n\nexport default LocalFileService\n```" + }, + { + "kind": "text", + "text": "\n\n:::note[Multer Typing]\n\nThe examples implement a file service supporting local uploads.\n\nIf you’re using TypeScript and you're following along with the implementation,\nyou should install the Multer types package in the root of your Medusa backend to resolve errors within your file service types:\n\n" + }, + { + "kind": "code", + "text": "```bash npm2yarn\nnpm install @types/multer\n```" + }, + { + "kind": "text", + "text": "\n\n:::\n\n---" + } + ] + }, + "children": [ + { + "id": 2871, + "name": "upload", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2872, + "name": "upload", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to upload a file to the Medusa backend." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the upload's result." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n // ...\n async upload(\n fileData: Express.Multer.File\n ): Promise {\n const filePath =\n `${this.publicPath}/${fileData.originalname}`\n fs.copyFileSync(fileData.path, filePath)\n return {\n url: `${this.serverUrl}/${filePath}`,\n key: filePath,\n }\n }\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::tip\n\nThis example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name.\n\n:::" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2873, + "name": "file", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A [multer file object](http://expressjs.com/en/resources/middleware/multer.html#file-information).\nThe file is uploaded to a temporary directory by default. Among the file’s details, you can access the file’s path in the " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": " property of the file object." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/multer/index.d.ts", + "qualifiedName": "__global.Express.Multer.File" + }, + "name": "File", + "package": "@types/multer", + "qualifiedName": "__global.Express.Multer.File" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 4766, + "name": "FileServiceUploadResult", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2874, + "name": "uploadProtected", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2875, + "name": "uploadProtected", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to upload a file to the Medusa backend, but to a protected storage. Typically, this would be used to store files that\nshouldn’t be accessible by using the file’s URL or should only be accessible by authenticated users. For example, exported or imported\nCSV files." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the upload's result." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n // ...\n async uploadProtected(\n fileData: Express.Multer.File\n ): Promise {\n const filePath =\n `${this.protectedPath}/${fileData.originalname}`\n fs.copyFileSync(fileData.path, filePath)\n return {\n url: `${this.serverUrl}/${filePath}`,\n key: filePath\n }\n }\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::tip\n\nThis example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name.\n\n:::" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2876, + "name": "file", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A [multer file object](http://expressjs.com/en/resources/middleware/multer.html#file-information).\nThe file is uploaded to a temporary directory by default. Among the file’s details, you can access the file’s path in the " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": " property of the file object." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/multer/index.d.ts", + "qualifiedName": "__global.Express.Multer.File" + }, + "name": "File", + "package": "@types/multer", + "qualifiedName": "__global.Express.Multer.File" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 4766, + "name": "FileServiceUploadResult", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2877, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2878, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to delete a file from storage." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Resolves when the file is deleted successfully." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n\n async delete(\n fileData: DeleteFileType\n ): Promise {\n fs.rmSync(fileData.fileKey)\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2879, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to remove." + } + ] + }, + "type": { + "type": "reference", + "target": 4854, + "name": "DeleteFileType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2880, + "name": "getUploadStreamDescriptor", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2881, + "name": "getUploadStreamDescriptor", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a write stream to be used to upload a file." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The result of the file-stream upload." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport { Stream } from \"stream\"\n\nclass LocalFileService extends AbstractFileService {\n // ...\n async getUploadStreamDescriptor({\n name,\n ext,\n isPrivate = true,\n }: UploadStreamDescriptorType\n ): Promise {\n const filePath = `${isPrivate ?\n this.publicPath : this.protectedPath\n }/${name}.${ext}`\n\n const pass = new Stream.PassThrough()\n const writeStream = fs.createWriteStream(filePath)\n\n pass.pipe(writeStream)\n\n return {\n writeStream: pass,\n promise: Promise.resolve(),\n url: `${this.serverUrl}/${filePath}`,\n fileKey: filePath,\n }\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2882, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file being uploaded." + } + ] + }, + "type": { + "type": "reference", + "target": 4856, + "name": "UploadStreamDescriptorType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 4860, + "name": "FileServiceGetUploadStreamResult", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2883, + "name": "getDownloadStream", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2884, + "name": "getDownloadStream", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a read stream for a file, which can then be used to download the file." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The [read stream](https://nodejs.org/api/webstreams.html#class-readablestream) to read and download the file." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n\n async getDownloadStream({\n fileKey,\n isPrivate = true,\n }: GetUploadedFileType\n ): Promise {\n const filePath = `${isPrivate ?\n this.publicPath : this.protectedPath\n }/${fileKey}`\n const readStream = fs.createReadStream(filePath)\n\n return readStream\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2885, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file." + } + ] + }, + "type": { + "type": "reference", + "target": 4865, + "name": "GetUploadedFileType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/@types/node/globals.d.ts", + "qualifiedName": "NodeJS.ReadableStream" + }, + "name": "ReadableStream", + "package": "@types/node", + "qualifiedName": "NodeJS.ReadableStream" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2886, + "name": "getPresignedDownloadUrl", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2887, + "name": "getPresignedDownloadUrl", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a download URL of the file. For some file services, such as S3, a presigned URL indicates a temporary URL to get access to a file.\n\nIf your file service doesn’t perform or offer a similar functionality, you can just return the URL to download the file." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The presigned URL to download the file" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n\n async getPresignedDownloadUrl({\n fileKey,\n isPrivate = true,\n }: GetUploadedFileType\n ): Promise {\n // Local upload doesn't provide\n // support for presigned URLs,\n // so just return the file's URL.\n\n const filePath = `${isPrivate ?\n this.publicPath : this.protectedPath\n }/${fileKey}`\n return `${this.serverUrl}/${filePath}`\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2888, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file." + } + ] + }, + "type": { + "type": "reference", + "target": 4865, + "name": "GetUploadedFileType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2889, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 2890, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 2891, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 2892, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + } + }, + { + "id": 2893, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 2894, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 2895, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 2896, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2897, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2898, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + } + }, + { + "id": 2899, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2900, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2901, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2902, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2903, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2903 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + }, + { + "id": 2904, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2905, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 2906, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 2907, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 2908, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2909, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2910, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2911, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 2912, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 2913, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2914, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2915, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 2916, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2917, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2918, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2919, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2889, + 2890, + 2893, + 2894, + 2895 + ] + }, + { + "title": "Accessors", + "children": [ + 2891 + ] + }, + { + "title": "Methods", + "children": [ + 2871, + 2874, + 2877, + 2880, + 2883, + 2886, + 2896, + 2899, + 2904 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 2920, + "name": "AbstractFileService" + } + ] + }, + { + "id": 2920, + "name": "AbstractFileService", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 2925, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2926, + "name": "new AbstractFileService", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your file service to access the different services in Medusa through dependency injection.\n\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs,\nyou can initialize it in the constructor and use it in other methods in the service.\n\nAdditionally, if you’re creating your file service as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin,\nyou can access them in the constructor." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport { Logger } from \"@medusajs/medusa\"\nimport * as fs from \"fs\"\n\nclass LocalFileService extends AbstractFileService {\n // can also be replaced by an environment variable\n // or a plugin option\n protected serverUrl = \"http://localhost:9000\"\n protected publicPath = \"uploads\"\n protected protectedPath = \"protected-uploads\"\n protected logger_: Logger\n\n constructor({ logger }: InjectedDependencies) {\n // @ts-ignore\n super(...arguments)\n this.logger_ = logger\n\n // for public uploads\n if (!fs.existsSync(this.publicPath)) {\n fs.mkdirSync(this.publicPath)\n }\n\n // for protected uploads\n if (!fs.existsSync(this.protectedPath)) {\n fs.mkdirSync(this.protectedPath)\n }\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2927, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 2928, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this file service is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 2920, + "name": "AbstractFileService", + "package": "@medusajs/medusa" + }, + "overwrites": { + "type": "reference", + "target": 3769, + "name": "TransactionBaseService.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": 3768, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 2929, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 2930, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this file service is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 2931, + "name": "upload", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 2932, + "name": "upload", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to upload a file to the Medusa backend." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the upload's result." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n // ...\n async upload(\n fileData: Express.Multer.File\n ): Promise {\n const filePath =\n `${this.publicPath}/${fileData.originalname}`\n fs.copyFileSync(fileData.path, filePath)\n return {\n url: `${this.serverUrl}/${filePath}`,\n key: filePath,\n }\n }\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::tip\n\nThis example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name.\n\n:::" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2933, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A [multer file object](http://expressjs.com/en/resources/middleware/multer.html#file-information).\nThe file is uploaded to a temporary directory by default. Among the file’s details, you can access the file’s path in the " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": " property of the file object." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/multer/index.d.ts", + "qualifiedName": "__global.Express.Multer.File" + }, + "name": "File", + "package": "@types/multer", + "qualifiedName": "__global.Express.Multer.File" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 4766, + "name": "FileServiceUploadResult", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2872, + "name": "IFileService.upload" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2871, + "name": "IFileService.upload" + } + }, + { + "id": 2934, + "name": "uploadProtected", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 2935, + "name": "uploadProtected", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to upload a file to the Medusa backend, but to a protected storage. Typically, this would be used to store files that\nshouldn’t be accessible by using the file’s URL or should only be accessible by authenticated users. For example, exported or imported\nCSV files." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the upload's result." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n // ...\n async uploadProtected(\n fileData: Express.Multer.File\n ): Promise {\n const filePath =\n `${this.protectedPath}/${fileData.originalname}`\n fs.copyFileSync(fileData.path, filePath)\n return {\n url: `${this.serverUrl}/${filePath}`,\n key: filePath\n }\n }\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::tip\n\nThis example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name.\n\n:::" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2936, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A [multer file object](http://expressjs.com/en/resources/middleware/multer.html#file-information).\nThe file is uploaded to a temporary directory by default. Among the file’s details, you can access the file’s path in the " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": " property of the file object." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/multer/index.d.ts", + "qualifiedName": "__global.Express.Multer.File" + }, + "name": "File", + "package": "@types/multer", + "qualifiedName": "__global.Express.Multer.File" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 4766, + "name": "FileServiceUploadResult", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2875, + "name": "IFileService.uploadProtected" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2874, + "name": "IFileService.uploadProtected" + } + }, + { + "id": 2937, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 2938, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to delete a file from storage." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Resolves when the file is deleted successfully." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n\n async delete(\n fileData: DeleteFileType\n ): Promise {\n fs.rmSync(fileData.fileKey)\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2939, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to remove." + } + ] + }, + "type": { + "type": "reference", + "target": 4854, + "name": "DeleteFileType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2878, + "name": "IFileService.delete" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2877, + "name": "IFileService.delete" + } + }, + { + "id": 2940, + "name": "getUploadStreamDescriptor", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 2941, + "name": "getUploadStreamDescriptor", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a write stream to be used to upload a file." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The result of the file-stream upload." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport { Stream } from \"stream\"\n\nclass LocalFileService extends AbstractFileService {\n // ...\n async getUploadStreamDescriptor({\n name,\n ext,\n isPrivate = true,\n }: UploadStreamDescriptorType\n ): Promise {\n const filePath = `${isPrivate ?\n this.publicPath : this.protectedPath\n }/${name}.${ext}`\n\n const pass = new Stream.PassThrough()\n const writeStream = fs.createWriteStream(filePath)\n\n pass.pipe(writeStream)\n\n return {\n writeStream: pass,\n promise: Promise.resolve(),\n url: `${this.serverUrl}/${filePath}`,\n fileKey: filePath,\n }\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2942, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file being uploaded." + } + ] + }, + "type": { + "type": "reference", + "target": 4856, + "name": "UploadStreamDescriptorType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 4860, + "name": "FileServiceGetUploadStreamResult", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2881, + "name": "IFileService.getUploadStreamDescriptor" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2880, + "name": "IFileService.getUploadStreamDescriptor" + } + }, + { + "id": 2943, + "name": "getDownloadStream", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 2944, + "name": "getDownloadStream", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a read stream for a file, which can then be used to download the file." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The [read stream](https://nodejs.org/api/webstreams.html#class-readablestream) to read and download the file." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n\n async getDownloadStream({\n fileKey,\n isPrivate = true,\n }: GetUploadedFileType\n ): Promise {\n const filePath = `${isPrivate ?\n this.publicPath : this.protectedPath\n }/${fileKey}`\n const readStream = fs.createReadStream(filePath)\n\n return readStream\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2945, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file." + } + ] + }, + "type": { + "type": "reference", + "target": 4865, + "name": "GetUploadedFileType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/@types/node/globals.d.ts", + "qualifiedName": "NodeJS.ReadableStream" + }, + "name": "ReadableStream", + "package": "@types/node", + "qualifiedName": "NodeJS.ReadableStream" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2884, + "name": "IFileService.getDownloadStream" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2883, + "name": "IFileService.getDownloadStream" + } + }, + { + "id": 2946, + "name": "getPresignedDownloadUrl", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 2947, + "name": "getPresignedDownloadUrl", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a download URL of the file. For some file services, such as S3, a presigned URL indicates a temporary URL to get access to a file.\n\nIf your file service doesn’t perform or offer a similar functionality, you can just return the URL to download the file." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The presigned URL to download the file" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n\n async getPresignedDownloadUrl({\n fileKey,\n isPrivate = true,\n }: GetUploadedFileType\n ): Promise {\n // Local upload doesn't provide\n // support for presigned URLs,\n // so just return the file's URL.\n\n const filePath = `${isPrivate ?\n this.publicPath : this.protectedPath\n }/${fileKey}`\n return `${this.serverUrl}/${filePath}`\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2948, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file." + } + ] + }, + "type": { + "type": "reference", + "target": 4865, + "name": "GetUploadedFileType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2887, + "name": "IFileService.getPresignedDownloadUrl" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2886, + "name": "IFileService.getPresignedDownloadUrl" + } + }, + { + "id": 2949, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + }, + "implementationOf": { + "type": "reference", + "target": 2889, + "name": "IFileService.manager_" + } + }, + { + "id": 2950, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + }, + "implementationOf": { + "type": "reference", + "target": 2890, + "name": "IFileService.transactionManager_" + } + }, + { + "id": 2951, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 2952, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "IFileService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + }, + "implementationOf": { + "type": "reference", + "target": 2891, + "name": "IFileService.activeManager_" + } + }, + { + "id": 2953, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + }, + "implementationOf": { + "type": "reference", + "target": 2893, + "name": "IFileService.__container__" + } + }, + { + "id": 2954, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + }, + "implementationOf": { + "type": "reference", + "target": 2894, + "name": "IFileService.__configModule__" + } + }, + { + "id": 2955, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + }, + "implementationOf": { + "type": "reference", + "target": 2895, + "name": "IFileService.__moduleDeclaration__" + } + }, + { + "id": 2956, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2957, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2958, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + }, + "implementationOf": { + "type": "reference", + "target": 2897, + "name": "IFileService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + }, + "implementationOf": { + "type": "reference", + "target": 2896, + "name": "IFileService.withTransaction" + } + }, + { + "id": 2959, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2960, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2961, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 2962, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2963, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2963 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + }, + "implementationOf": { + "type": "reference", + "target": 2900, + "name": "IFileService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + }, + "implementationOf": { + "type": "reference", + "target": 2899, + "name": "IFileService.shouldRetryTransaction_" + } + }, + { + "id": 2964, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 2965, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 2966, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 2967, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 2968, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2969, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2970, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2971, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 2972, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 2973, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2974, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2975, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 2976, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2977, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2978, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2979, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + }, + "implementationOf": { + "type": "reference", + "target": 2905, + "name": "IFileService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + }, + "implementationOf": { + "type": "reference", + "target": 2904, + "name": "IFileService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 2925 + ] + }, + { + "title": "Properties", + "children": [ + 2929, + 2930, + 2949, + 2950, + 2953, + 2954, + 2955 + ] + }, + { + "title": "Accessors", + "children": [ + 2951 + ] + }, + { + "title": "Methods", + "children": [ + 2931, + 2934, + 2937, + 2940, + 2943, + 2946, + 2956, + 2959, + 2964 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 2870, + "name": "IFileService", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 4880, + "name": "FulfillmentProviderData", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 4879, + "name": "ShippingOptionData", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 4881, + "name": "ShippingMethodData", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 2980, + "name": "FulfillmentService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\nA fulfillment provider is the shipping provider used to fulfill orders and deliver them to customers. An example of a fulfillment provider is FedEx.\n\nBy default, a Medusa Backend has a " + }, + { + "kind": "code", + "text": "`manual`" + }, + { + "kind": "text", + "text": " fulfillment provider which has minimal implementation. It allows you to accept orders and fulfill them manually. However, you can integrate any fulfillment provider into Medusa, and your fulfillment provider can interact with third-party shipping providers.\n\nA fulfillment provider is a service that extends the " + }, + { + "kind": "code", + "text": "`AbstractFulfillmentService`" + }, + { + "kind": "text", + "text": " and implements its methods. So, adding a fulfillment provider is as simple as creating a service file in " + }, + { + "kind": "code", + "text": "`src/services`" + }, + { + "kind": "text", + "text": ".\nThe file's name is the fulfillment provider's class name as a slug and without the word " + }, + { + "kind": "code", + "text": "`Service`" + }, + { + "kind": "text", + "text": ". For example, if you're creating a " + }, + { + "kind": "code", + "text": "`MyFulfillmentService`" + }, + { + "kind": "text", + "text": " class, the file name is " + }, + { + "kind": "code", + "text": "`src/services/my-fulfillment.ts`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```ts title=src/services/my-fulfillment.ts\nimport { AbstractFulfillmentService } from \"@medusajs/medusa\"\n\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // methods here...\n}\n\nexport default MyFulfillmentService\n```" + }, + { + "kind": "text", + "text": "\n\n---\n\n## Identifier Property\n\nThe " + }, + { + "kind": "code", + "text": "`FulfillmentProvider`" + }, + { + "kind": "text", + "text": " entity has 2 properties: " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`is_installed`" + }, + { + "kind": "text", + "text": ". The " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " property in the fulfillment provider service is used when the fulfillment provider is added to the database.\n\nThe value of this property is also used to reference the fulfillment provider throughout Medusa. For example, it is used to [add a fulfillment provider](https://docs.medusajs.com/api/admin#regions_postregionsregionfulfillmentproviders) to a region.\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n static identifier = \"my-fulfillment\"\n\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---" + } + ] + }, + "children": [ + { + "id": 2983, + "name": "getFulfillmentOptions", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2984, + "name": "getFulfillmentOptions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used when retrieving the list of fulfillment options available in a region, particularly by the [List Fulfillment Options API Route](https://docs.medusajs.com/api/admin#regions_getregionsregionfulfillmentoptions).\nFor example, if you’re integrating UPS as a fulfillment provider, you might support two fulfillment options: UPS Express Shipping and UPS Access Point. Each of these options can have different data associated with them." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The list of fulfillment options. These options don't have any required format. Later on, these options can be used when creating a shipping option,\nsuch as when using the [Create Shipping Option API Route](https://docs.medusajs.com/api/admin#shipping-options_postshippingoptions). The chosen fulfillment option, which is one of the\nitems in the array returned by this method, will be set in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object of the shipping option." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async getFulfillmentOptions(): Promise {\n return [\n {\n id: \"my-fulfillment\",\n },\n {\n id: \"my-fulfillment-dynamic\",\n },\n ]\n }\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2985, + "name": "validateFulfillmentData", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2986, + "name": "validateFulfillmentData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is called when a shipping method is created. This typically happens when the customer chooses a shipping option during checkout, when a shipping method is created\nfor an order return, or in other similar cases. The shipping option and its data are validated before the shipping method is created.\n\nYou can use the provided parameters to validate the chosen shipping option. For example, you can check if the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object passed as a second parameter includes all data needed to\nfulfill the shipment later on.\n\nIf any of the data is invalid, you can throw an error. This error will stop Medusa from creating a shipping method and the error message will be returned as a result of the API Route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The data that will be stored in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " property of the shipping method to be created.\nMake sure the value you return contains everything you need to fulfill the shipment later on. The returned value may also be used to calculate the price of the shipping method\nif it doesn't have a set price. It will be passed along to the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "calculatePrice", + "target": 2996, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " method." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async validateFulfillmentData(\n optionData: Record,\n data: Record,\n cart: Cart\n ): Promise> {\n if (data.id !== \"my-fulfillment\") {\n throw new Error(\"invalid data\")\n }\n\n return {\n ...data,\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2987, + "name": "optionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data object of the shipping option selected when creating the shipping method." + } + ] + }, + "type": { + "type": "reference", + "target": 4879, + "name": "ShippingOptionData", + "package": "@medusajs/medusa" + } + }, + { + "id": 2988, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object passed in the body of the request." + } + ] + }, + "type": { + "type": "reference", + "target": 4880, + "name": "FulfillmentProviderData", + "package": "@medusajs/medusa" + } + }, + { + "id": 2989, + "name": "cart", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's cart details. It may be empty if the shipping method isn't associated with a cart, such as when it's associated with a claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2990, + "name": "validateOption", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2991, + "name": "validateOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Once the admin creates the shipping option, the data of the shipping option will be validated first using this method. This method is called when the [Create Shipping Option API Route](https://docs.medusajs.com/api/admin#shipping-options_postshippingoptions) is used." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Whether the fulfillment option is valid. If the returned value is false, an error is thrown and the shipping option will not be saved." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, you can use this method to ensure that the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object is correct:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async validateOption(\n data: Record\n ): Promise {\n return data.id == \"my-fulfillment\"\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2992, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the data object that is sent in the body of the request, basically, the data object of the shipping option. You can use this data to validate the shipping option before it is saved." + } + ] + }, + "type": { + "type": "reference", + "target": 4879, + "name": "ShippingOptionData", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "boolean" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2993, + "name": "canCalculate", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2994, + "name": "canCalculate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to determine whether a shipping option is calculated dynamically or flat rate. It is called if the " + }, + { + "kind": "code", + "text": "`price_type`" + }, + { + "kind": "text", + "text": " of the shipping option being created is set to calculated." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "If this method returns " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", that means that the price can be calculated dynamically and the shipping option can have the " + }, + { + "kind": "code", + "text": "`price_type`" + }, + { + "kind": "text", + "text": " set to calculated.\nThe amount property of the shipping option will then be set to null. The amount will be created later when the shipping method is created on checkout using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "calculatePrice", + "target": 2996, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " method.\nIf the method returns " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ", an error is thrown as it means the selected shipping option is invalid and it can only have the " + }, + { + "kind": "code", + "text": "`flat_rate`" + }, + { + "kind": "text", + "text": " price type." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async canCalculate(\n data: Record\n ): Promise {\n return data.id === \"my-fulfillment-dynamic\"\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2995, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object of the shipping option being created. You can use this data to determine whether the shipping option should be calculated or not.\nThis is useful if the fulfillment provider you are integrating has both flat rate and dynamically priced fulfillment options." + } + ] + }, + "type": { + "type": "reference", + "target": 4879, + "name": "ShippingOptionData", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "boolean" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 2996, + "name": "calculatePrice", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2997, + "name": "calculatePrice", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used in different places, including:\n\n1. When the shipping options for a cart are retrieved during checkout. If a shipping option has their " + }, + { + "kind": "code", + "text": "`price_type`" + }, + { + "kind": "text", + "text": " set to calculated, this method is used to set the amount of the returned shipping option.\n2. When a shipping method is created. If the shipping option associated with the method has their " + }, + { + "kind": "code", + "text": "`price_type`" + }, + { + "kind": "text", + "text": " set to " + }, + { + "kind": "code", + "text": "`calculated`" + }, + { + "kind": "text", + "text": ", this method is used to set the " + }, + { + "kind": "code", + "text": "`price`" + }, + { + "kind": "text", + "text": " attribute of the shipping method in the database.\n3. When the cart's totals are calculated." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Used to set the price of the shipping method or option, based on the context the method is used in." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "An example of calculating the price based on some custom logic:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async calculatePrice(\n optionData: Record,\n data: Record,\n cart: Cart\n ): Promise {\n return cart.items.length * 1000\n }\n}\n```" + }, + { + "kind": "text", + "text": "\n\nIf your fulfillment provider does not provide any dynamically calculated rates you can return any static value or throw an error. For example:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async calculatePrice(\n optionData: Record,\n data: Record,\n cart: Cart\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 2998, + "name": "optionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object of the selected shipping option." + } + ] + }, + "type": { + "type": "reference", + "target": 4879, + "name": "ShippingOptionData", + "package": "@medusajs/medusa" + } + }, + { + "id": 2999, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object that is different based on the context it's used in:\n\n1. If the price is being calculated for the list of shipping options available for a cart, it's the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object of the shipping option.\n2. If the price is being calculated when the shipping method is being created, it's the data returned by the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "validateFulfillmentData", + "target": 2985, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " method used during the shipping method creation.\n3. If the price is being calculated while calculating the cart's totals, it will be the data object of the cart's shipping method." + } + ] + }, + "type": { + "type": "reference", + "target": 4880, + "name": "FulfillmentProviderData", + "package": "@medusajs/medusa" + } + }, + { + "id": 3000, + "name": "cart", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Either the Cart or the Order object." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3001, + "name": "createFulfillment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3002, + "name": "createFulfillment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used when a fulfillment is created for an order, a claim, or a swap." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The data that will be stored in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attribute of the created fulfillment." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Here is a basic implementation of " + }, + { + "kind": "code", + "text": "`createFulfillment`" + }, + { + "kind": "text", + "text": " for a fulfillment provider that does not interact with any third-party provider to create the fulfillment:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async createFulfillment(\n data: Record,\n items: LineItem[],\n order: Order,\n fulfillment: Fulfillment\n ) {\n // No data is being sent anywhere\n // No data to be stored in the fulfillment's data object\n return {}\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3003, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object of the shipping method associated with the resource, such as the order.\nYou can use it to access the data specific to the shipping option. This is based on your implementation of previous methods." + } + ] + }, + "type": { + "type": "reference", + "target": 4881, + "name": "ShippingMethodData", + "package": "@medusajs/medusa" + } + }, + { + "id": 3004, + "name": "items", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line items in the order to be fulfilled. The admin can choose all or some of the items to fulfill." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", + "qualifiedName": "LineItem" + }, + "name": "LineItem", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3005, + "name": "order", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the created resource, which is either an order, a claim, or a swap:\n- If the resource the fulfillment is being created for is a claim, the " + }, + { + "kind": "code", + "text": "`is_claim`" + }, + { + "kind": "text", + "text": " property in the object will be " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ".\n- If the resource the fulfillment is being created for is a swap, the " + }, + { + "kind": "code", + "text": "`is_swap`" + }, + { + "kind": "text", + "text": " property in the object will be " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ".\n- Otherwise, the resource is an order." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 3006, + "name": "fulfillment", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The fulfillment being created." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/fulfillment.ts", + "qualifiedName": "Fulfillment" + }, + "name": "Fulfillment", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 4880, + "name": "FulfillmentProviderData", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3007, + "name": "cancelFulfillment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3008, + "name": "cancelFulfillment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is called when a fulfillment is cancelled by the admin. This fulfillment can be for an order, a claim, or a swap." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The method isn't expected to return any specific data." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "This is the basic implementation of the method for a fulfillment provider that doesn't interact with a third-party provider to cancel the fulfillment:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async cancelFulfillment(\n fulfillment: Record\n ): Promise {\n return {}\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3009, + "name": "fulfillmentData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attribute of the fulfillment being canceled" + } + ] + }, + "type": { + "type": "reference", + "target": 4880, + "name": "FulfillmentProviderData", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3010, + "name": "createReturn", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3011, + "name": "createReturn", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fulfillment providers can also be used to return products. A shipping option can be used for returns if the " + }, + { + "kind": "code", + "text": "`is_return`" + }, + { + "kind": "text", + "text": " property is true or if an admin creates a Return Shipping Option from the settings.\nThis method is used when the admin [creates a return request](https://docs.medusajs.com/api/admin#orders_postordersorderreturns) for an order,\n[creates a swap](https://docs.medusajs.com/api/admin#orders_postordersorderswaps) for an order, or when the\n[customer creates a return of their order](https://docs.medusajs.com/api/store#returns_postreturns). The fulfillment is created automatically for the order return." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Used to set the value of the " + }, + { + "kind": "code", + "text": "`shipping_data`" + }, + { + "kind": "text", + "text": " attribute of the return being created." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "This is the basic implementation of the method for a fulfillment provider that does not contact with a third-party provider to fulfill the return:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async createReturn(\n returnOrder: CreateReturnType\n ): Promise> {\n return {}\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3012, + "name": "returnOrder", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the return that the fulfillment is being created for." + } + ] + }, + "type": { + "type": "reference", + "target": 4882, + "name": "CreateReturnType", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3013, + "name": "getFulfillmentDocuments", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3014, + "name": "getFulfillmentDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve any documents associated with a fulfillment. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async getFulfillmentDocuments(\n data: Record\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getFulfillmentDocuments()\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3015, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attribute of the fulfillment that you're retrieving the documents for." + } + ] + }, + "type": { + "type": "reference", + "target": 4880, + "name": "FulfillmentProviderData", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3016, + "name": "getReturnDocuments", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3017, + "name": "getReturnDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve any documents associated with a return. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async getReturnDocuments(\n data: Record\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getReturnDocuments()\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3018, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data attribute of the return that you're retrieving the documents for." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3019, + "name": "getShipmentDocuments", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3020, + "name": "getShipmentDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve any documents associated with a shipment. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async getShipmentDocuments(\n data: Record\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getShipmentDocuments()\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3021, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attribute of the shipment that you're retrieving the documents for." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3022, + "name": "retrieveDocuments", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3023, + "name": "retrieveDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve any documents associated with an order and its fulfillments. This method isn't used by default in the backend, but you can use it for\ncustom use cases such as allowing admins to download these documents." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async retrieveDocuments(\n fulfillmentData: Record,\n documentType: \"invoice\" | \"label\"\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getDocuments()\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3024, + "name": "fulfillmentData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attribute of the order's fulfillment." + } + ] + }, + "type": { + "type": "reference", + "target": 4880, + "name": "FulfillmentProviderData", + "package": "@medusajs/medusa" + } + }, + { + "id": 3025, + "name": "documentType", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of document to retrieve." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "label" + }, + { + "type": "literal", + "value": "invoice" + } + ] + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3026, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 3027, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 3028, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 3029, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + } + }, + { + "id": 3030, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 3031, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 3032, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 3033, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3034, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3035, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + } + }, + { + "id": 3036, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3037, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3038, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 3039, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3040, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3040 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + }, + { + "id": 3041, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3042, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 3043, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3044, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 3045, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3046, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3047, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3048, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 3049, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 3050, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3051, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3052, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 3053, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3054, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3055, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3056, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3026, + 3027, + 3030, + 3031, + 3032 + ] + }, + { + "title": "Accessors", + "children": [ + 3028 + ] + }, + { + "title": "Methods", + "children": [ + 2983, + 2985, + 2990, + 2993, + 2996, + 3001, + 3007, + 3010, + 3013, + 3016, + 3019, + 3022, + 3033, + 3036, + 3041 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 3057, + "name": "AbstractFulfillmentService" + } + ] + }, + { + "id": 3057, + "name": "AbstractFulfillmentService", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 3063, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3064, + "name": "new AbstractFulfillmentService", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your fulfillment provider to access the different services in Medusa through dependency injection.\n\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the service.\nAdditionally, if you’re creating your fulfillment provider as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, you can access it in the constructor." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n constructor(container, options) {\n super(container)\n // you can access options here\n\n // you can also initialize a client that\n // communicates with a third-party service.\n this.client = new Client(options)\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3065, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 3066, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this fulfillment provider is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 3057, + "name": "AbstractFulfillmentService", + "package": "@medusajs/medusa" + }, + "overwrites": { + "type": "reference", + "target": 3769, + "name": "TransactionBaseService.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": 3768, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 3067, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 3068, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this fulfillment provider is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3062, + "name": "identifier", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true, + "isStatic": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`FulfillmentProvider`" + }, + { + "kind": "text", + "text": " entity has 2 properties: " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`is_installed`" + }, + { + "kind": "text", + "text": ". The " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " property in the class is used when the fulfillment provider is created in the database.\nThe value of this property is also used to reference the fulfillment provider throughout Medusa. For example, it is used to [add a fulfillment provider](https://docs.medusajs.com/api/admin#regions_postregionsregionfulfillmentproviders) to a region." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n static identifier = \"my-fulfillment\"\n\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3071, + "name": "getFulfillmentOptions", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3072, + "name": "getFulfillmentOptions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used when retrieving the list of fulfillment options available in a region, particularly by the [List Fulfillment Options API Route](https://docs.medusajs.com/api/admin#regions_getregionsregionfulfillmentoptions).\nFor example, if you’re integrating UPS as a fulfillment provider, you might support two fulfillment options: UPS Express Shipping and UPS Access Point. Each of these options can have different data associated with them." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The list of fulfillment options. These options don't have any required format. Later on, these options can be used when creating a shipping option,\nsuch as when using the [Create Shipping Option API Route](https://docs.medusajs.com/api/admin#shipping-options_postshippingoptions). The chosen fulfillment option, which is one of the\nitems in the array returned by this method, will be set in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object of the shipping option." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async getFulfillmentOptions(): Promise {\n return [\n {\n id: \"my-fulfillment\",\n },\n {\n id: \"my-fulfillment-dynamic\",\n },\n ]\n }\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2984, + "name": "FulfillmentService.getFulfillmentOptions" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2983, + "name": "FulfillmentService.getFulfillmentOptions" + } + }, + { + "id": 3073, + "name": "validateFulfillmentData", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3074, + "name": "validateFulfillmentData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is called when a shipping method is created. This typically happens when the customer chooses a shipping option during checkout, when a shipping method is created\nfor an order return, or in other similar cases. The shipping option and its data are validated before the shipping method is created.\n\nYou can use the provided parameters to validate the chosen shipping option. For example, you can check if the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object passed as a second parameter includes all data needed to\nfulfill the shipment later on.\n\nIf any of the data is invalid, you can throw an error. This error will stop Medusa from creating a shipping method and the error message will be returned as a result of the API Route." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The data that will be stored in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " property of the shipping method to be created.\nMake sure the value you return contains everything you need to fulfill the shipment later on. The returned value may also be used to calculate the price of the shipping method\nif it doesn't have a set price. It will be passed along to the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "calculatePrice", + "target": 2996, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " method." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async validateFulfillmentData(\n optionData: Record,\n data: Record,\n cart: Cart\n ): Promise> {\n if (data.id !== \"my-fulfillment\") {\n throw new Error(\"invalid data\")\n }\n\n return {\n ...data,\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3075, + "name": "optionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data object of the shipping option selected when creating the shipping method." + } + ] + }, + "type": { + "type": "reference", + "target": 4879, + "name": "ShippingOptionData", + "package": "@medusajs/medusa" + } + }, + { + "id": 3076, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object passed in the body of the request." + } + ] + }, + "type": { + "type": "reference", + "target": 4880, + "name": "FulfillmentProviderData", + "package": "@medusajs/medusa" + } + }, + { + "id": 3077, + "name": "cart", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2986, + "name": "FulfillmentService.validateFulfillmentData" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2985, + "name": "FulfillmentService.validateFulfillmentData" + } + }, + { + "id": 3078, + "name": "validateOption", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3079, + "name": "validateOption", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Once the admin creates the shipping option, the data of the shipping option will be validated first using this method. This method is called when the [Create Shipping Option API Route](https://docs.medusajs.com/api/admin#shipping-options_postshippingoptions) is used." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Whether the fulfillment option is valid. If the returned value is false, an error is thrown and the shipping option will not be saved." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, you can use this method to ensure that the " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object is correct:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async validateOption(\n data: Record\n ): Promise {\n return data.id == \"my-fulfillment\"\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3080, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the data object that is sent in the body of the request, basically, the data object of the shipping option. You can use this data to validate the shipping option before it is saved." + } + ] + }, + "type": { + "type": "reference", + "target": 4879, + "name": "ShippingOptionData", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "boolean" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2991, + "name": "FulfillmentService.validateOption" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2990, + "name": "FulfillmentService.validateOption" + } + }, + { + "id": 3081, + "name": "canCalculate", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3082, + "name": "canCalculate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to determine whether a shipping option is calculated dynamically or flat rate. It is called if the " + }, + { + "kind": "code", + "text": "`price_type`" + }, + { + "kind": "text", + "text": " of the shipping option being created is set to calculated." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "If this method returns " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ", that means that the price can be calculated dynamically and the shipping option can have the " + }, + { + "kind": "code", + "text": "`price_type`" + }, + { + "kind": "text", + "text": " set to calculated.\nThe amount property of the shipping option will then be set to null. The amount will be created later when the shipping method is created on checkout using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "calculatePrice", + "target": 2996, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " method.\nIf the method returns " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ", an error is thrown as it means the selected shipping option is invalid and it can only have the " + }, + { + "kind": "code", + "text": "`flat_rate`" + }, + { + "kind": "text", + "text": " price type." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async canCalculate(\n data: Record\n ): Promise {\n return data.id === \"my-fulfillment-dynamic\"\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3083, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object of the shipping option being created. You can use this data to determine whether the shipping option should be calculated or not.\nThis is useful if the fulfillment provider you are integrating has both flat rate and dynamically priced fulfillment options." + } + ] + }, + "type": { + "type": "reference", + "target": 4879, + "name": "ShippingOptionData", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "boolean" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2994, + "name": "FulfillmentService.canCalculate" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2993, + "name": "FulfillmentService.canCalculate" + } + }, + { + "id": 3084, + "name": "calculatePrice", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3085, + "name": "calculatePrice", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used in different places, including:\n\n1. When the shipping options for a cart are retrieved during checkout. If a shipping option has their " + }, + { + "kind": "code", + "text": "`price_type`" + }, + { + "kind": "text", + "text": " set to calculated, this method is used to set the amount of the returned shipping option.\n2. When a shipping method is created. If the shipping option associated with the method has their " + }, + { + "kind": "code", + "text": "`price_type`" + }, + { + "kind": "text", + "text": " set to " + }, + { + "kind": "code", + "text": "`calculated`" + }, + { + "kind": "text", + "text": ", this method is used to set the " + }, + { + "kind": "code", + "text": "`price`" + }, + { + "kind": "text", + "text": " attribute of the shipping method in the database.\n3. When the cart's totals are calculated." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Used to set the price of the shipping method or option, based on the context the method is used in." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "An example of calculating the price based on some custom logic:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async calculatePrice(\n optionData: Record,\n data: Record,\n cart: Cart\n ): Promise {\n return cart.items.length * 1000\n }\n}\n```" + }, + { + "kind": "text", + "text": "\n\nIf your fulfillment provider does not provide any dynamically calculated rates you can return any static value or throw an error. For example:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async calculatePrice(\n optionData: Record,\n data: Record,\n cart: Cart\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3086, + "name": "optionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object of the selected shipping option." + } + ] + }, + "type": { + "type": "reference", + "target": 4879, + "name": "ShippingOptionData", + "package": "@medusajs/medusa" + } + }, + { + "id": 3087, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object that is different based on the context it's used in:\n\n1. If the price is being calculated for the list of shipping options available for a cart, it's the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object of the shipping option.\n2. If the price is being calculated when the shipping method is being created, it's the data returned by the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "validateFulfillmentData", + "target": 2985, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " method used during the shipping method creation.\n3. If the price is being calculated while calculating the cart's totals, it will be the data object of the cart's shipping method." + } + ] + }, + "type": { + "type": "reference", + "target": 4880, + "name": "FulfillmentProviderData", + "package": "@medusajs/medusa" + } + }, + { + "id": 3088, + "name": "cart", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 2997, + "name": "FulfillmentService.calculatePrice" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2996, + "name": "FulfillmentService.calculatePrice" + } + }, + { + "id": 3089, + "name": "createFulfillment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3090, + "name": "createFulfillment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used when a fulfillment is created for an order, a claim, or a swap." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The data that will be stored in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attribute of the created fulfillment." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Here is a basic implementation of " + }, + { + "kind": "code", + "text": "`createFulfillment`" + }, + { + "kind": "text", + "text": " for a fulfillment provider that does not interact with any third-party provider to create the fulfillment:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async createFulfillment(\n data: Record,\n items: LineItem[],\n order: Order,\n fulfillment: Fulfillment\n ) {\n // No data is being sent anywhere\n // No data to be stored in the fulfillment's data object\n return {}\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3091, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object of the shipping method associated with the resource, such as the order.\nYou can use it to access the data specific to the shipping option. This is based on your implementation of previous methods." + } + ] + }, + "type": { + "type": "reference", + "target": 4881, + "name": "ShippingMethodData", + "package": "@medusajs/medusa" + } + }, + { + "id": 3092, + "name": "items", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line items in the order to be fulfilled. The admin can choose all or some of the items to fulfill." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", + "qualifiedName": "LineItem" + }, + "name": "LineItem", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3093, + "name": "order", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/order.ts", + "qualifiedName": "Order" + }, + "name": "Order", + "package": "@medusajs/medusa" + } + }, + { + "id": 3094, + "name": "fulfillment", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/fulfillment.ts", + "qualifiedName": "Fulfillment" + }, + "name": "Fulfillment", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 4880, + "name": "FulfillmentProviderData", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3002, + "name": "FulfillmentService.createFulfillment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3001, + "name": "FulfillmentService.createFulfillment" + } + }, + { + "id": 3095, + "name": "cancelFulfillment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3096, + "name": "cancelFulfillment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is called when a fulfillment is cancelled by the admin. This fulfillment can be for an order, a claim, or a swap." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The method isn't expected to return any specific data." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "This is the basic implementation of the method for a fulfillment provider that doesn't interact with a third-party provider to cancel the fulfillment:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async cancelFulfillment(\n fulfillment: Record\n ): Promise {\n return {}\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3097, + "name": "fulfillment", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attribute of the fulfillment being canceled" + } + ] + }, + "type": { + "type": "reference", + "target": 4880, + "name": "FulfillmentProviderData", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3008, + "name": "FulfillmentService.cancelFulfillment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3007, + "name": "FulfillmentService.cancelFulfillment" + } + }, + { + "id": 3098, + "name": "createReturn", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3099, + "name": "createReturn", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fulfillment providers can also be used to return products. A shipping option can be used for returns if the " + }, + { + "kind": "code", + "text": "`is_return`" + }, + { + "kind": "text", + "text": " property is true or if an admin creates a Return Shipping Option from the settings.\nThis method is used when the admin [creates a return request](https://docs.medusajs.com/api/admin#orders_postordersorderreturns) for an order,\n[creates a swap](https://docs.medusajs.com/api/admin#orders_postordersorderswaps) for an order, or when the\n[customer creates a return of their order](https://docs.medusajs.com/api/store#returns_postreturns). The fulfillment is created automatically for the order return." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Used to set the value of the " + }, + { + "kind": "code", + "text": "`shipping_data`" + }, + { + "kind": "text", + "text": " attribute of the return being created." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "This is the basic implementation of the method for a fulfillment provider that does not contact with a third-party provider to fulfill the return:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends AbstractFulfillmentService {\n // ...\n async createReturn(\n returnOrder: CreateReturnType\n ): Promise> {\n return {}\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3100, + "name": "returnOrder", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the return that the fulfillment is being created for." + } + ] + }, + "type": { + "type": "reference", + "target": 4882, + "name": "CreateReturnType", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3011, + "name": "FulfillmentService.createReturn" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3010, + "name": "FulfillmentService.createReturn" + } + }, + { + "id": 3101, + "name": "getFulfillmentDocuments", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3102, + "name": "getFulfillmentDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve any documents associated with a fulfillment. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async getFulfillmentDocuments(\n data: Record\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getFulfillmentDocuments()\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3103, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attribute of the fulfillment that you're retrieving the documents for." + } + ] + }, + "type": { + "type": "reference", + "target": 4880, + "name": "FulfillmentProviderData", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3014, + "name": "FulfillmentService.getFulfillmentDocuments" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3013, + "name": "FulfillmentService.getFulfillmentDocuments" + } + }, + { + "id": 3104, + "name": "getReturnDocuments", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3105, + "name": "getReturnDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve any documents associated with a return. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async getReturnDocuments(\n data: Record\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getReturnDocuments()\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3106, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data attribute of the return that you're retrieving the documents for." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3017, + "name": "FulfillmentService.getReturnDocuments" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3016, + "name": "FulfillmentService.getReturnDocuments" + } + }, + { + "id": 3107, + "name": "getShipmentDocuments", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3108, + "name": "getShipmentDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve any documents associated with a shipment. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async getShipmentDocuments(\n data: Record\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getShipmentDocuments()\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3109, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attribute of the shipment that you're retrieving the documents for." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3020, + "name": "FulfillmentService.getShipmentDocuments" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3019, + "name": "FulfillmentService.getShipmentDocuments" + } + }, + { + "id": 3110, + "name": "retrieveDocuments", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3111, + "name": "retrieveDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve any documents associated with an order and its fulfillments. This method isn't used by default in the backend, but you can use it for\ncustom use cases such as allowing admins to download these documents." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "There are no restrictions on the returned response. If your fulfillment provider doesn't provide this functionality, you can leave the method empty or through an error." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyFulfillmentService extends FulfillmentService {\n // ...\n async retrieveDocuments(\n fulfillmentData: Record,\n documentType: \"invoice\" | \"label\"\n ): Promise {\n // assuming you contact a client to\n // retrieve the document\n return this.client.getDocuments()\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3112, + "name": "fulfillmentData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attribute of the order's fulfillment." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3113, + "name": "documentType", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of document to retrieve." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "label" + }, + { + "type": "literal", + "value": "invoice" + } + ] + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3023, + "name": "FulfillmentService.retrieveDocuments" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3022, + "name": "FulfillmentService.retrieveDocuments" + } + }, + { + "id": 3114, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + }, + "implementationOf": { + "type": "reference", + "target": 3026, + "name": "FulfillmentService.manager_" + } + }, + { + "id": 3115, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + }, + "implementationOf": { + "type": "reference", + "target": 3027, + "name": "FulfillmentService.transactionManager_" + } + }, + { + "id": 3116, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 3117, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "FulfillmentService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + }, + "implementationOf": { + "type": "reference", + "target": 3028, + "name": "FulfillmentService.activeManager_" + } + }, + { + "id": 3118, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + }, + "implementationOf": { + "type": "reference", + "target": 3030, + "name": "FulfillmentService.__container__" + } + }, + { + "id": 3119, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + }, + "implementationOf": { + "type": "reference", + "target": 3031, + "name": "FulfillmentService.__configModule__" + } + }, + { + "id": 3120, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + }, + "implementationOf": { + "type": "reference", + "target": 3032, + "name": "FulfillmentService.__moduleDeclaration__" + } + }, + { + "id": 3121, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3122, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3123, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + }, + "implementationOf": { + "type": "reference", + "target": 3034, + "name": "FulfillmentService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + }, + "implementationOf": { + "type": "reference", + "target": 3033, + "name": "FulfillmentService.withTransaction" + } + }, + { + "id": 3124, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3125, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3126, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 3127, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3128, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3128 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + }, + "implementationOf": { + "type": "reference", + "target": 3037, + "name": "FulfillmentService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + }, + "implementationOf": { + "type": "reference", + "target": 3036, + "name": "FulfillmentService.shouldRetryTransaction_" + } + }, + { + "id": 3129, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3130, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 3131, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3132, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 3133, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3134, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3135, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3136, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 3137, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 3138, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3139, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3140, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 3141, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3142, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3143, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3144, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + }, + "implementationOf": { + "type": "reference", + "target": 3042, + "name": "FulfillmentService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + }, + "implementationOf": { + "type": "reference", + "target": 3041, + "name": "FulfillmentService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3063 + ] + }, + { + "title": "Properties", + "children": [ + 3067, + 3068, + 3062, + 3114, + 3115, + 3118, + 3119, + 3120 + ] + }, + { + "title": "Accessors", + "children": [ + 3116 + ] + }, + { + "title": "Methods", + "children": [ + 3071, + 3073, + 3078, + 3081, + 3084, + 3089, + 3095, + 3098, + 3101, + 3104, + 3107, + 3110, + 3121, + 3124, + 3129 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 2980, + "name": "FulfillmentService", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 3145, + "name": "ReturnedData", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of a sent or resent notification." + } + ] + }, + "children": [ + { + "id": 3146, + "name": "to", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The receiver of the Notification. For example, if you sent an email to the customer then " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " is the email address of the customer.\nIn other cases, it might be a phone number or a username." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3147, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The status of the sent notification. There are no restriction on the returned status." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3148, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data used to send the Notification. For example, if you sent an order confirmation email to the customer, then the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object\nmight include the order items or the subject of the email. This " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " is necessary if the notification is resent later as you can use the same data." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3146, + 3147, + 3148 + ] + } + ] + }, + { + "id": 3149, + "name": "INotificationService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\n:::note[Prerequisites]\n\nBefore creating a Notification Provider, [install an event bus module](https://docs.medusajs.com/development/events/modules/redis).\n\n:::\n\nA Notification Provider is a provider that handles sending and resending of notifications.\n\nTo create a Notification Provider, create a TypeScript or JavaScript file in " + }, + { + "kind": "code", + "text": "`src/services`" + }, + { + "kind": "text", + "text": ". The name of the file is the name of the provider\n(for example, " + }, + { + "kind": "code", + "text": "`sendgrid.ts`" + }, + { + "kind": "text", + "text": "). The file must export a class that extends the " + }, + { + "kind": "code", + "text": "`AbstractNotificationService`" + }, + { + "kind": "text", + "text": " class imported from " + }, + { + "kind": "code", + "text": "`@medusajs/medusa`" + }, + { + "kind": "text", + "text": ".\n\nFor example, create the file " + }, + { + "kind": "code", + "text": "`src/services/email-sender.ts`" + }, + { + "kind": "text", + "text": " with the following content:\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/services/email-sender.ts\"\nimport { AbstractNotificationService } from \"@medusajs/medusa\"\nimport { EntityManager } from \"typeorm\"\n\nclass EmailSenderService extends AbstractNotificationService {\n protected manager_: EntityManager\n protected transactionManager_: EntityManager\n\n sendNotification(\n event: string,\n data: unknown,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record;\n }> {\n throw new Error(\"Method not implemented.\")\n }\n resendNotification(\n notification: unknown,\n config: unknown,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record;\n }> {\n throw new Error(\"Method not implemented.\")\n }\n\n}\n\nexport default EmailSenderService\n```" + }, + { + "kind": "text", + "text": "\n\n---\n\n## Identifier Property\n\nThe " + }, + { + "kind": "code", + "text": "`NotificationProvider`" + }, + { + "kind": "text", + "text": " entity has 2 properties: " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`is_installed`" + }, + { + "kind": "text", + "text": ". The value of the " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " property in the notification provider\nclass is used when the Notification Provider is created in the database.\n\nThe value of this property is also used later when you want to subscribe the Notification Provider to events in a [Loader](https://docs.medusajs.com/development/loaders/overview).\n\nFor example:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass EmailSenderService extends AbstractNotificationService {\n static identifier = \"email-sender\"\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---" + } + ] + }, + "children": [ + { + "id": 3150, + "name": "sendNotification", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3151, + "name": "sendNotification", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When an event is triggered that your Notification Provider is registered as a handler for, the [" + }, + { + "kind": "code", + "text": "`NotificationService`" + }, + { + "kind": "text", + "text": "](https://docs.medusajs.com/references/services/classes/services.NotificationService)\nin the Medusa backend executes this method of your Notification Provider.\n\nIn this method, you can perform the necessary operation to send the Notification. For example, you can send an email to the customer when they place an order." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The sending details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass EmailSenderService extends AbstractNotificationService {\n // ...\n async sendNotification(\n event: string,\n data: any,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record;\n }> {\n if (event === \"order.placed\") {\n // retrieve order\n const order = await this.orderService.retrieve(data.id)\n // TODO send email\n\n console.log(\"Notification sent\")\n return {\n to: order.email,\n status: \"done\",\n data: {\n // any data necessary to send the email\n // for example:\n subject: \"You placed a new order!\",\n items: order.items,\n },\n }\n }\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3152, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the event that was triggered. For example, " + }, + { + "kind": "code", + "text": "`order.placed`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3153, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data payload of the event that was triggered. For example, if the " + }, + { + "kind": "code", + "text": "`order.placed`" + }, + { + "kind": "text", + "text": " event is triggered,\nthe " + }, + { + "kind": "code", + "text": "`eventData`" + }, + { + "kind": "text", + "text": " object contains the property " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " which is the ID of the order that was placed. You can refer to the\n[Events reference](https://docs.medusajs.com/development/events/events-list) for information on all events and their payloads." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 3154, + "name": "attachmentGenerator", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If you’ve previously register an attachment generator to the " + }, + { + "kind": "code", + "text": "`NotificationService`" + }, + { + "kind": "text", + "text": " using the\n[" + }, + { + "kind": "code", + "text": "`registerAttachmentGenerator`" + }, + { + "kind": "text", + "text": "](https://docs.medusajs.com/references/services/classes/services.NotificationService#registerattachmentgenerator) method,\nyou have access to it here. You can use the " + }, + { + "kind": "code", + "text": "`attachmentGenerator`" + }, + { + "kind": "text", + "text": " to generate on-demand invoices or other documents. The default value of this parameter is " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3145, + "name": "ReturnedData", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3155, + "name": "resendNotification", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3156, + "name": "resendNotification", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to resend notifications, which is typically triggered by the\n[Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The resend details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass EmailSenderService extends AbstractNotificationService {\n // ...\n async resendNotification(\n notification: any,\n config: any,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record;\n }> {\n // check if the receiver should be changed\n const to: string = config.to || notification.to\n\n // TODO resend the notification using the same data\n // that is saved under notification.data\n\n console.log(\"Notification resent\")\n return {\n to,\n status: \"done\",\n data: notification.data, // make changes to the data\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3157, + "name": "notification", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The original [Notification record](https://docs.medusajs.com/references/entities/classes/Notification) that was created after you sent the\nnotification with " + }, + { + "kind": "code", + "text": "`sendNotification`" + }, + { + "kind": "text", + "text": ". It includes the " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attributes which are populated originally using the " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " properties of\nthe object you return in " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "sendNotification", + "target": 3150, + "tsLinkText": "" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 3158, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new configuration used to resend the notification. The [Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend),\nallows you to pass a new " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " field. If specified, it will be available in this config object." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 3159, + "name": "attachmentGenerator", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "f you’ve previously register an attachment generator to the " + }, + { + "kind": "code", + "text": "`NotificationService`" + }, + { + "kind": "text", + "text": " using the\n[" + }, + { + "kind": "code", + "text": "`registerAttachmentGenerator`" + }, + { + "kind": "text", + "text": "](https://docs.medusajs.com/references/services/classes/services.NotificationService#registerattachmentgenerator) method,\nyou have access to it here. You can use the " + }, + { + "kind": "code", + "text": "`attachmentGenerator`" + }, + { + "kind": "text", + "text": " to generate on-demand invoices or other documents. The default value of this parameter is " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3145, + "name": "ReturnedData", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3160, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 3161, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 3162, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 3163, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + } + }, + { + "id": 3164, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 3165, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 3166, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 3167, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3168, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3169, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + } + }, + { + "id": 3170, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3171, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3172, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 3173, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3174, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3174 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + }, + { + "id": 3175, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3176, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 3177, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3178, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 3179, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3180, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3181, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3182, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 3183, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 3184, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3185, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3186, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 3187, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3188, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3189, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3190, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3160, + 3161, + 3164, + 3165, + 3166 + ] + }, + { + "title": "Accessors", + "children": [ + 3162 + ] + }, + { + "title": "Methods", + "children": [ + 3150, + 3155, + 3167, + 3170, + 3175 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 3191, + "name": "AbstractNotificationService" + } + ] + }, + { + "id": 3191, + "name": "AbstractNotificationService", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 3193, + "name": "identifier", + "variant": "declaration", + "kind": 1024, + "flags": { + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3197, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3198, + "name": "new AbstractNotificationService", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your notification provider to access the different services in Medusa through dependency injection.\n\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs,\nyou can initialize it in the constructor and use it in other methods in the service.\n\nAdditionally, if you’re creating your notification provider as an external plugin to be installed on any Medusa backend and you want to access the options\nadded for the plugin, you can access it in the constructor." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport { AbstractNotificationService, OrderService } from \"@medusajs/medusa\"\nimport { EntityManager } from \"typeorm\"\n\nclass EmailSenderService extends AbstractNotificationService {\n // ...\n protected orderService: OrderService\n\n constructor(container, options) {\n super(container)\n // you can access options here in case you're\n // using a plugin\n\n this.orderService = container.orderService\n\n // you can also initialize a client that\n // communicates with a third-party service.\n this.client = new Client(options)\n }\n\n // ...\n}\n\nexport default EmailSenderService\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3199, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 3200, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this notification provider is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 3191, + "name": "AbstractNotificationService", + "package": "@medusajs/medusa" + }, + "overwrites": { + "type": "reference", + "target": 3769, + "name": "TransactionBaseService.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": 3768, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 3203, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 3204, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this notification provider is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3205, + "name": "sendNotification", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3206, + "name": "sendNotification", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When an event is triggered that your Notification Provider is registered as a handler for, the [" + }, + { + "kind": "code", + "text": "`NotificationService`" + }, + { + "kind": "text", + "text": "](https://docs.medusajs.com/references/services/classes/services.NotificationService)\nin the Medusa backend executes this method of your Notification Provider.\n\nIn this method, you can perform the necessary operation to send the Notification. For example, you can send an email to the customer when they place an order." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The sending details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass EmailSenderService extends AbstractNotificationService {\n // ...\n async sendNotification(\n event: string,\n data: any,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record;\n }> {\n if (event === \"order.placed\") {\n // retrieve order\n const order = await this.orderService.retrieve(data.id)\n // TODO send email\n\n console.log(\"Notification sent\")\n return {\n to: order.email,\n status: \"done\",\n data: {\n // any data necessary to send the email\n // for example:\n subject: \"You placed a new order!\",\n items: order.items,\n },\n }\n }\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3207, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the event that was triggered. For example, " + }, + { + "kind": "code", + "text": "`order.placed`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3208, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data payload of the event that was triggered. For example, if the " + }, + { + "kind": "code", + "text": "`order.placed`" + }, + { + "kind": "text", + "text": " event is triggered,\nthe " + }, + { + "kind": "code", + "text": "`eventData`" + }, + { + "kind": "text", + "text": " object contains the property " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " which is the ID of the order that was placed. You can refer to the\n[Events reference](https://docs.medusajs.com/development/events/events-list) for information on all events and their payloads." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 3209, + "name": "attachmentGenerator", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If you’ve previously register an attachment generator to the " + }, + { + "kind": "code", + "text": "`NotificationService`" + }, + { + "kind": "text", + "text": " using the\n[" + }, + { + "kind": "code", + "text": "`registerAttachmentGenerator`" + }, + { + "kind": "text", + "text": "](https://docs.medusajs.com/references/services/classes/services.NotificationService#registerattachmentgenerator) method,\nyou have access to it here. You can use the " + }, + { + "kind": "code", + "text": "`attachmentGenerator`" + }, + { + "kind": "text", + "text": " to generate on-demand invoices or other documents. The default value of this parameter is " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3145, + "name": "ReturnedData", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3151, + "name": "INotificationService.sendNotification" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3150, + "name": "INotificationService.sendNotification" + } + }, + { + "id": 3210, + "name": "resendNotification", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3211, + "name": "resendNotification", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to resend notifications, which is typically triggered by the\n[Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The resend details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass EmailSenderService extends AbstractNotificationService {\n // ...\n async resendNotification(\n notification: any,\n config: any,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record;\n }> {\n // check if the receiver should be changed\n const to: string = config.to || notification.to\n\n // TODO resend the notification using the same data\n // that is saved under notification.data\n\n console.log(\"Notification resent\")\n return {\n to,\n status: \"done\",\n data: notification.data, // make changes to the data\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3212, + "name": "notification", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The original [Notification record](https://docs.medusajs.com/references/entities/classes/Notification) that was created after you sent the\nnotification with " + }, + { + "kind": "code", + "text": "`sendNotification`" + }, + { + "kind": "text", + "text": ". It includes the " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attributes which are populated originally using the " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " properties of\nthe object you return in " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "sendNotification", + "target": 3150, + "tsLinkText": "" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 3213, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new configuration used to resend the notification. The [Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend),\nallows you to pass a new " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " field. If specified, it will be available in this config object." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 3214, + "name": "attachmentGenerator", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "f you’ve previously register an attachment generator to the " + }, + { + "kind": "code", + "text": "`NotificationService`" + }, + { + "kind": "text", + "text": " using the\n[" + }, + { + "kind": "code", + "text": "`registerAttachmentGenerator`" + }, + { + "kind": "text", + "text": "](https://docs.medusajs.com/references/services/classes/services.NotificationService#registerattachmentgenerator) method,\nyou have access to it here. You can use the " + }, + { + "kind": "code", + "text": "`attachmentGenerator`" + }, + { + "kind": "text", + "text": " to generate on-demand invoices or other documents. The default value of this parameter is " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3145, + "name": "ReturnedData", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3156, + "name": "INotificationService.resendNotification" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3155, + "name": "INotificationService.resendNotification" + } + }, + { + "id": 3215, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + }, + "implementationOf": { + "type": "reference", + "target": 3160, + "name": "INotificationService.manager_" + } + }, + { + "id": 3216, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + }, + "implementationOf": { + "type": "reference", + "target": 3161, + "name": "INotificationService.transactionManager_" + } + }, + { + "id": 3217, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 3218, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "INotificationService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + }, + "implementationOf": { + "type": "reference", + "target": 3162, + "name": "INotificationService.activeManager_" + } + }, + { + "id": 3219, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + }, + "implementationOf": { + "type": "reference", + "target": 3164, + "name": "INotificationService.__container__" + } + }, + { + "id": 3220, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + }, + "implementationOf": { + "type": "reference", + "target": 3165, + "name": "INotificationService.__configModule__" + } + }, + { + "id": 3221, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + }, + "implementationOf": { + "type": "reference", + "target": 3166, + "name": "INotificationService.__moduleDeclaration__" + } + }, + { + "id": 3222, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3223, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3224, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + }, + "implementationOf": { + "type": "reference", + "target": 3168, + "name": "INotificationService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + }, + "implementationOf": { + "type": "reference", + "target": 3167, + "name": "INotificationService.withTransaction" + } + }, + { + "id": 3225, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3226, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3227, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 3228, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3229, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3229 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + }, + "implementationOf": { + "type": "reference", + "target": 3171, + "name": "INotificationService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + }, + "implementationOf": { + "type": "reference", + "target": 3170, + "name": "INotificationService.shouldRetryTransaction_" + } + }, + { + "id": 3230, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3231, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 3232, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3233, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 3234, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3235, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3236, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3237, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 3238, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 3239, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3240, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3241, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 3242, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3243, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3244, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3245, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + }, + "implementationOf": { + "type": "reference", + "target": 3176, + "name": "INotificationService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + }, + "implementationOf": { + "type": "reference", + "target": 3175, + "name": "INotificationService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3197 + ] + }, + { + "title": "Properties", + "children": [ + 3193, + 3203, + 3204, + 3215, + 3216, + 3219, + 3220, + 3221 + ] + }, + { + "title": "Accessors", + "children": [ + 3217 + ] + }, + { + "title": "Methods", + "children": [ + 3205, + 3210, + 3222, + 3225, + 3230 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 3149, + "name": "INotificationService", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 3249, + "name": "PaymentProcessorContext", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A payment's context." + } + ] + }, + "children": [ + { + "id": 3250, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment's billing address." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/address.ts", + "qualifiedName": "Address" + }, + "name": "Address", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 3251, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer's email." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3252, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The selected currency code, typically associated with the customer's cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3253, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The payment's amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3254, + "name": "resource_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the resource the payment is associated with. For example, the cart's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3255, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer associated with this payment." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + }, + { + "id": 3256, + "name": "context", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's context." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3257, + "name": "paymentSessionData", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the payment session hasn't been created or initiated yet, it'll be an empty object.\nIf the payment session exists, it'll be the value of the payment session's " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3250, + 3251, + 3252, + 3253, + 3254, + 3255, + 3256, + 3257 + ] + } + ] + }, + { + "id": 3258, + "name": "PaymentProcessorSessionResponse", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The response of operations on a payment." + } + ] + }, + "children": [ + { + "id": 3259, + "name": "update_requests", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to specify data that should be updated in the Medusa backend." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3260, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3261, + "name": "customer_metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Specifies a new value of the " + }, + { + "kind": "code", + "text": "`metadata`" + }, + { + "kind": "text", + "text": " field of the customer associated with the payment." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3261 + ] + } + ] + } + } + }, + { + "id": 3262, + "name": "session_data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to be stored in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment Session to be created.\nThe " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field is useful to hold any data required by the third-party provider to process the payment or retrieve its details at a later point." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3259, + 3262 + ] + } + ] + }, + { + "id": 3263, + "name": "PaymentProcessorError", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object that is returned in case of an error." + } + ] + }, + "children": [ + { + "id": 3264, + "name": "error", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The error message" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3265, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The error code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3266, + "name": "detail", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Any additional helpful details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3264, + 3265, + 3266 + ] + } + ] + }, + { + "id": 3267, + "name": "PaymentProcessor", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\nA Payment Processor is the payment method used to authorize, capture, and refund payment, among other actions. An example of a Payment Processor is Stripe.\n\nBy default, Medusa has a " + }, + { + "kind": "code", + "text": "`manual`" + }, + { + "kind": "text", + "text": " payment provider that has minimal implementation. It can be synonymous with a Cash on Delivery payment method. It allows\nstore operators to manage the payment themselves but still keep track of its different stages on Medusa.\n\nA payment processor is a service that extends the " + }, + { + "kind": "code", + "text": "`AbstractPaymentProcessor`" + }, + { + "kind": "text", + "text": " and implements its methods. So, adding a Payment Processor is as simple as\ncreating a service file in " + }, + { + "kind": "code", + "text": "`src/services`" + }, + { + "kind": "text", + "text": ". The file's name is the payment processor's class name as a slug and without the word " + }, + { + "kind": "code", + "text": "`Service`" + }, + { + "kind": "text", + "text": ".\nFor example, if you're creating a " + }, + { + "kind": "code", + "text": "`MyPaymentService`" + }, + { + "kind": "text", + "text": " class, the file name is " + }, + { + "kind": "code", + "text": "`src/services/my-payment.ts`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport { AbstractPaymentProcessor } from \"@medusajs/medusa\";\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // methods here...\n}\n\nexport default MyPaymentService\n```" + }, + { + "kind": "text", + "text": "\n\nThe methods of the payment processor are used at different points in the Checkout flow as well as when processing an order after it’s placed.\n\n![Checkout Flow - Payment](https://res.cloudinary.com/dza7lstvk/image/upload/v1680177820/Medusa%20Docs/Diagrams/checkout-payment_cy9efp.jpg)\n\n---\n\n## Identifier Property\n\nThe " + }, + { + "kind": "code", + "text": "`PaymentProvider`" + }, + { + "kind": "text", + "text": " entity has 2 properties: " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`is_installed`" + }, + { + "kind": "text", + "text": ". The " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " property in the payment processor service is used when the payment processor is added to the database.\n\nThe value of this property is also used to reference the payment processor throughout Medusa.\nFor example, it is used to [add a payment processor](https://docs.medusajs.com/api/admin#regions_postregionsregionpaymentproviders) to a region.\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyPaymentService extends AbstractPaymentProcessor {\n static identifier = \"my-payment\"\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---\n\n## PaymentProcessorError\n\nBefore diving into the methods of the Payment Processor, you'll notice that part of the expected return signature of these method includes " + }, + { + "kind": "code", + "text": "`PaymentProcessorError`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```ts\ninterface PaymentProcessorError {\n error: string\n code?: string\n detail?: any\n}\n```" + }, + { + "kind": "text", + "text": "\n\nWhile implementing the Payment Processor's methods, if you need to inform the Medusa core that an error occurred at a certain stage,\nreturn an object having the attributes defined in the " + }, + { + "kind": "code", + "text": "`PaymentProcessorError`" + }, + { + "kind": "text", + "text": " interface.\n\nFor example, the Stripe payment processor has the following method to create the error object, which is used within other methods:\n\n" + }, + { + "kind": "code", + "text": "```ts\nabstract class StripeBase extends AbstractPaymentProcessor {\n // ...\n protected buildError(\n message: string,\n e: Stripe.StripeRawError | PaymentProcessorError | Error\n ): PaymentProcessorError {\n return {\n error: message,\n code: \"code\" in e ? e.code : \"\",\n detail: isPaymentProcessorError(e)\n ? `${e.error}${EOL}${e.detail ?? \"\"}`\n : \"detail\" in e\n ? e.detail\n : e.message ?? \"\",\n }\n }\n\n // used in other methods\n async retrievePayment(\n paymentSessionData: Record\n ): Promise<\n PaymentProcessorError |\n PaymentProcessorSessionResponse[\"session_data\"]\n > {\n try {\n // ...\n } catch (e) {\n return this.buildError(\n \"An error occurred in retrievePayment\",\n e\n )\n }\n }\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---" + } + ] + }, + "children": [ + { + "id": 3270, + "name": "initiatePayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3271, + "name": "initiatePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is called either if a region has only one payment provider enabled or when [a Payment Session is selected](https://docs.medusajs.com/api/store#carts_postcartscartpaymentsession),\nwhich occurs when the customer selects their preferred payment method during checkout.\n\nIt is used to allow you to make any necessary calls to the third-party provider to initialize the payment. For example, in Stripe this method is used to create a Payment Intent for the customer." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Either the payment's data or an error object." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentContext,\n PaymentSessionResponse,\n // ...\n} from \"@medusajs/medusa\"\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async initiatePayment(\n context: PaymentProcessorContext\n ): Promise<\n PaymentProcessorError | PaymentProcessorSessionResponse\n > {\n // assuming client is an initialized client\n // communicating with a third-party service.\n const clientPayment = await this.client.initiate(context)\n\n return {\n session_data: {\n id: clientPayment.id\n },\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3272, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context of the payment." + } + ] + }, + "type": { + "type": "reference", + "target": 3249, + "name": "PaymentProcessorContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3258, + "name": "PaymentProcessorSessionResponse", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3273, + "name": "updatePayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3274, + "name": "updatePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to update the payment session when the payment amount changes. It's called whenever the cart or any of its related data is updated.\nFor example, when a [line item is added to the cart](https://docs.medusajs.com/api/store#carts_postcartscartlineitems) or when a\n[shipping method is selected](https://docs.medusajs.com/api/store#carts_postcartscartshippingmethod)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Either the payment's data or an error object." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorContext,\n PaymentProcessorError,\n PaymentProcessorSessionResponse,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async updatePayment(\n context: PaymentProcessorContext\n ): Promise<\n void |\n PaymentProcessorError |\n PaymentProcessorSessionResponse\n > {\n // assuming client is an initialized client\n // communicating with a third-party service.\n const paymentId = context.paymentSessionData.id\n\n await this.client.update(paymentId, context)\n\n return {\n session_data: context.paymentSessionData\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3275, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context of the payment." + } + ] + }, + "type": { + "type": "reference", + "target": 3249, + "name": "PaymentProcessorContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3258, + "name": "PaymentProcessorSessionResponse", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3276, + "name": "refundPayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3277, + "name": "refundPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to refund an order’s payment. This is typically triggered manually by the store operator from the admin. The refund amount might be the total order amount or part of it.\n\nThis method is also used for refunding payments of a swap or a claim of an order, or when a request is sent to the [Refund Payment API Route](https://docs.medusajs.com/api/admin#payments_postpaymentspaymentrefunds).\n\nYou can utilize this method to interact with the third-party provider and perform any actions necessary to refund the payment." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Either an error object or a value that's stored in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async refundPayment(\n paymentSessionData: Record,\n refundAmount: number\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n const refundData = this.client.refund(paymentId, refundAmount)\n\n return {\n id: paymentId,\n ...refundData\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3278, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of a Payment." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3279, + "name": "refundAmount", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the amount to refund." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3280, + "name": "authorizePayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3281, + "name": "authorizePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to authorize payment using the Payment Session of an order. This is called when the\n[cart is completed](https://docs.medusajs.com/api/store#carts_postcartscartcomplete) and before the order is created.\n\nThis method is also used for authorizing payments of a swap of an order and when authorizing sessions in a payment collection.\nYou can interact with a third-party provider and perform any actions necessary to authorize the payment.\n\nThe payment authorization might require additional action from the customer before it is declared authorized. Once that additional action is performed,\nthe " + }, + { + "kind": "code", + "text": "`authorizePayment`" + }, + { + "kind": "text", + "text": " method will be called again to validate that the payment is now fully authorized. So, make sure to implement it for this case as well, if necessary.\n\nOnce the payment is authorized successfully and the Payment Session status is set to " + }, + { + "kind": "code", + "text": "`authorized`" + }, + { + "kind": "text", + "text": ", the associated order or swap can then be placed or created.\nIf the payment authorization fails, then an error will be thrown and the order will not be created.\n\n:::note\n\nThe payment authorization status is determined using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "getPaymentStatus", + "target": 3299, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " method. If the status is " + }, + { + "kind": "code", + "text": "`requires_more`" + }, + { + "kind": "text", + "text": ", then it means additional actions are required\nfrom the customer. If you try to create the order with a status that isn't " + }, + { + "kind": "code", + "text": "`authorized`" + }, + { + "kind": "text", + "text": ", the process will fail.\n\n:::" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The authorization details or an error object." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError,\n PaymentSessionStatus,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async authorizePayment(\n paymentSessionData: Record,\n context: Record\n ): Promise<\n PaymentProcessorError |\n {\n status: PaymentSessionStatus;\n data: Record;\n }\n > {\n try {\n await this.client.authorize(paymentSessionData.id)\n\n return {\n status: PaymentSessionStatus.AUTHORIZED,\n data: {\n id: paymentSessionData.id\n }\n }\n } catch (e) {\n return {\n error: e.message\n }\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3282, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the payment session." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3283, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context of the authorization. It may include some of the following fields:\n\n- " + }, + { + "kind": "code", + "text": "`ip`" + }, + { + "kind": "text", + "text": ": The customer’s IP.\n- " + }, + { + "kind": "code", + "text": "`idempotency_key`" + }, + { + "kind": "text", + "text": ": The [Idempotency Key](https://docs.medusajs.com/modules/carts-and-checkout/payment#idempotency-key) that is associated with the current cart. It is useful when retrying payments, retrying checkout at a failed point, or for payments that require additional actions from the customer.\n- " + }, + { + "kind": "code", + "text": "`cart_id`" + }, + { + "kind": "text", + "text": ": The ID of a cart. This is only during operations like placing an order or creating a swap." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 3284, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3285, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The status of the payment, which will be stored in the payment session's " + }, + { + "kind": "code", + "text": "`status`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSessionStatus" + }, + "name": "PaymentSessionStatus", + "package": "@medusajs/medusa" + } + }, + { + "id": 3286, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " to be stored in the payment session's " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3285, + 3286 + ] + } + ] + } + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3287, + "name": "capturePayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3288, + "name": "capturePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to capture the payment amount of an order. This is typically triggered manually by the store operator from the admin.\n\nThis method is also used for capturing payments of a swap of an order, or when a request is sent to the [Capture Payment API Route](https://docs.medusajs.com/api/admin#payments_postpaymentspaymentcapture).\n\nYou can utilize this method to interact with the third-party provider and perform any actions necessary to capture the payment." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Either an error object or a value that's stored in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async capturePayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n const captureData = this.client.catch(paymentId)\n\n return {\n id: paymentId,\n ...captureData\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3289, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment for its first parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3290, + "name": "deletePayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3291, + "name": "deletePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to perform any actions necessary before a Payment Session is deleted. The Payment Session is deleted in one of the following cases:\n\n1. When a request is sent to [delete the Payment Session](https://docs.medusajs.com/api/store#carts_deletecartscartpaymentsessionssession).\n2. When the [Payment Session is refreshed](https://docs.medusajs.com/api/store#carts_postcartscartpaymentsessionssession). The Payment Session is deleted so that a newer one is initialized instead.\n3. When the Payment Processor is no longer available. This generally happens when the store operator removes it from the available Payment Processor in the admin.\n4. When the region of the store is changed based on the cart information and the Payment Processor is not available in the new region." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Either an error object or an empty object." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async deletePayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n // assuming client is an initialized client\n // communicating with a third-party service.\n this.client.delete(paymentId)\n\n return {}\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3292, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment Session." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3293, + "name": "retrievePayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3294, + "name": "retrievePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to provide a uniform way of retrieving the payment information from the third-party provider.\nFor example, in Stripe’s Payment Processor this method is used to retrieve the payment intent details from Stripe." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The payment's data, typically retrieved from a third-party provider." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async retrievePayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n return await this.client.retrieve(paymentId)\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3295, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of a Payment Session. Make sure to store in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field any necessary data that would allow you to retrieve the payment data from the third-party provider." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3296, + "name": "cancelPayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3297, + "name": "cancelPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to cancel an order’s payment. This method is typically triggered by one of the following situations:\n\n1. Before an order is placed and after the payment is authorized, an inventory check is done on products to ensure that products are still available for purchase. If the inventory check fails for any of the products, the payment is canceled.\n2. If the store operator cancels the order from the admin.\n3. When the payment of an order's swap is canceled.\n\nYou can utilize this method to interact with the third-party provider and perform any actions necessary to cancel the payment." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Either an error object or a value that's stored in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async cancelPayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n const cancelData = this.client.cancel(paymentId)\n\n return {\n id: paymentId,\n ...cancelData\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3298, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3299, + "name": "getPaymentStatus", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3300, + "name": "getPaymentStatus", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to get the status of a Payment or a Payment Session. Its main usage is within the place order and create swap flows.\nIf the status returned is not " + }, + { + "kind": "code", + "text": "`authorized`" + }, + { + "kind": "text", + "text": " within these flows, then the payment is considered failed and an error will be thrown, stopping the flow from completion." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The status of the Payment or Payment Session." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentSessionStatus\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async getPaymentStatus(\n paymentSessionData: Record\n ): Promise {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n return await this.client.getStatus(paymentId) as PaymentSessionStatus\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3301, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of a Payment as a parameter. You can use this data to interact with the third-party provider to check the status of the payment if necessary." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSessionStatus" + }, + "name": "PaymentSessionStatus", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3302, + "name": "updatePaymentData", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3303, + "name": "updatePaymentData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to update the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of a payment session. It's called when a request is sent to the\n[Update Payment Session API Route](https://docs.medusajs.com/api/store#carts_postcartscartpaymentsessionupdate), or when the " + }, + { + "kind": "code", + "text": "`CartService`" + }, + { + "kind": "text", + "text": "'s " + }, + { + "kind": "code", + "text": "`updatePaymentSession`" + }, + { + "kind": "text", + "text": " is used.\n\nThis method can also be used to update the data in the third-party payment provider, if necessary." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the data to store in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the payment session.\nYou can keep the data as-is, or make changes to it by communicating with the third-party provider." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError,\n PaymentProviderService,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n protected paymentProviderService: PaymentProviderService\n // ...\n constructor(container, options) {\n super(container)\n this.paymentProviderService = container.paymentProviderService\n // ...\n }\n // ...\n async updatePaymentData(\n sessionId: string,\n data: Record\n ): Promise<\n Record |\n PaymentProcessorError\n > {\n const paymentSession = await this.paymentProviderService.retrieveSession(sessionId)\n // assuming client is an initialized client\n // communicating with a third-party service.\n const clientPayment = await this.client.update(paymentSession.data.id, data)\n\n return {\n id: clientPayment.id\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3304, + "name": "sessionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the payment session." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3305, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to be updated in the payment session." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 3270, + 3273, + 3276, + 3280, + 3287, + 3290, + 3293, + 3296, + 3299, + 3302 + ] + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 3306, + "name": "AbstractPaymentProcessor" + } + ] + }, + { + "id": 3306, + "name": "AbstractPaymentProcessor", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\nA Payment Processor is the payment method used to authorize, capture, and refund payment, among other actions. An example of a Payment Processor is Stripe.\n\nBy default, Medusa has a " + }, + { + "kind": "code", + "text": "`manual`" + }, + { + "kind": "text", + "text": " payment provider that has minimal implementation. It can be synonymous with a Cash on Delivery payment method. It allows\nstore operators to manage the payment themselves but still keep track of its different stages on Medusa.\n\nA payment processor is a service that extends the " + }, + { + "kind": "code", + "text": "`AbstractPaymentProcessor`" + }, + { + "kind": "text", + "text": " and implements its methods. So, adding a Payment Processor is as simple as\ncreating a service file in " + }, + { + "kind": "code", + "text": "`src/services`" + }, + { + "kind": "text", + "text": ". The file's name is the payment processor's class name as a slug and without the word " + }, + { + "kind": "code", + "text": "`Service`" + }, + { + "kind": "text", + "text": ".\nFor example, if you're creating a " + }, + { + "kind": "code", + "text": "`MyPaymentService`" + }, + { + "kind": "text", + "text": " class, the file name is " + }, + { + "kind": "code", + "text": "`src/services/my-payment.ts`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport { AbstractPaymentProcessor } from \"@medusajs/medusa\";\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // methods here...\n}\n\nexport default MyPaymentService\n```" + }, + { + "kind": "text", + "text": "\n\nThe methods of the payment processor are used at different points in the Checkout flow as well as when processing an order after it’s placed.\n\n![Checkout Flow - Payment](https://res.cloudinary.com/dza7lstvk/image/upload/v1680177820/Medusa%20Docs/Diagrams/checkout-payment_cy9efp.jpg)\n\n---\n\n## Identifier Property\n\nThe " + }, + { + "kind": "code", + "text": "`PaymentProvider`" + }, + { + "kind": "text", + "text": " entity has 2 properties: " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`is_installed`" + }, + { + "kind": "text", + "text": ". The " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " property in the payment processor service is used when the payment processor is added to the database.\n\nThe value of this property is also used to reference the payment processor throughout Medusa.\nFor example, it is used to [add a payment processor](https://docs.medusajs.com/api/admin#regions_postregionsregionpaymentproviders) to a region.\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyPaymentService extends AbstractPaymentProcessor {\n static identifier = \"my-payment\"\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---\n\n## PaymentProcessorError\n\nBefore diving into the methods of the Payment Processor, you'll notice that part of the expected return signature of these method includes " + }, + { + "kind": "code", + "text": "`PaymentProcessorError`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```ts\ninterface PaymentProcessorError {\n error: string\n code?: string\n detail?: any\n}\n```" + }, + { + "kind": "text", + "text": "\n\nWhile implementing the Payment Processor's methods, if you need to inform the Medusa core that an error occurred at a certain stage,\nreturn an object having the attributes defined in the " + }, + { + "kind": "code", + "text": "`PaymentProcessorError`" + }, + { + "kind": "text", + "text": " interface.\n\nFor example, the Stripe payment processor has the following method to create the error object, which is used within other methods:\n\n" + }, + { + "kind": "code", + "text": "```ts\nabstract class StripeBase extends AbstractPaymentProcessor {\n // ...\n protected buildError(\n message: string,\n e: Stripe.StripeRawError | PaymentProcessorError | Error\n ): PaymentProcessorError {\n return {\n error: message,\n code: \"code\" in e ? e.code : \"\",\n detail: isPaymentProcessorError(e)\n ? `${e.error}${EOL}${e.detail ?? \"\"}`\n : \"detail\" in e\n ? e.detail\n : e.message ?? \"\",\n }\n }\n\n // used in other methods\n async retrievePayment(\n paymentSessionData: Record\n ): Promise<\n PaymentProcessorError |\n PaymentProcessorSessionResponse[\"session_data\"]\n > {\n try {\n // ...\n } catch (e) {\n return this.buildError(\n \"An error occurred in retrievePayment\",\n e\n )\n }\n }\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---" + } + ] + }, + "children": [ + { + "id": 3312, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3313, + "name": "new AbstractPaymentProcessor", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your Payment Processor to have access to different services in Medusa through [dependency injection](https://docs.medusajs.com/development/fundamentals/dependency-injection).\n\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs,\nyou can initialize it in the constructor and use it in other methods in the service.\n\nAdditionally, if you’re creating your Payment Processor as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin,\nyou can access it in the constructor. The options are passed as a second parameter." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n constructor(container, options) {\n super(container)\n // you can access options here\n\n // you can also initialize a client that\n // communicates with a third-party service.\n this.client = new Client(options)\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3314, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend through [dependency injection](https://docs.medusajs.com/development/fundamentals/dependency-injection)" + } + ] + }, + "type": { + "type": "reference", + "target": 4883, + "name": "MedusaContainer", + "package": "medusa-core-utils" + } + }, + { + "id": 3315, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this fulfillment provider is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 3306, + "name": "AbstractPaymentProcessor", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 3316, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend through [dependency injection](https://docs.medusajs.com/development/fundamentals/dependency-injection)" + } + ] + }, + "type": { + "type": "reference", + "target": 4883, + "name": "MedusaContainer", + "package": "medusa-core-utils" + } + }, + { + "id": 3317, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this fulfillment provider is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3307, + "name": "_isPaymentProcessor", + "variant": "declaration", + "kind": 1024, + "flags": { + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "true" + }, + { + "id": 3308, + "name": "isPaymentProcessor", + "variant": "declaration", + "kind": 2048, + "flags": { + "isStatic": true + }, + "signatures": [ + { + "id": 3309, + "name": "isPaymentProcessor", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3310, + "name": "object", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 3311, + "name": "identifier", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true, + "isStatic": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`PaymentProvider`" + }, + { + "kind": "text", + "text": " entity has 2 properties: " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`is_installed`" + }, + { + "kind": "text", + "text": ". The " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " property in the payment processor service is used when the payment processor is added to the database.\n\nThe value of this property is also used to reference the payment processor throughout Medusa.\nFor example, it is used to [add a payment processor](https://docs.medusajs.com/api/admin#regions_postregionsregionpaymentproviders) to a region.\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MyPaymentService extends AbstractPaymentProcessor {\n static identifier = \"my-payment\"\n // ...\n}\n```" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3320, + "name": "capturePayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3321, + "name": "capturePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to capture the payment amount of an order. This is typically triggered manually by the store operator from the admin.\n\nThis method is also used for capturing payments of a swap of an order, or when a request is sent to the [Capture Payment API Route](https://docs.medusajs.com/api/admin#payments_postpaymentspaymentcapture).\n\nYou can utilize this method to interact with the third-party provider and perform any actions necessary to capture the payment." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Either an error object or a value that's stored in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async capturePayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n const captureData = this.client.catch(paymentId)\n\n return {\n id: paymentId,\n ...captureData\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3322, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment for its first parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3288, + "name": "PaymentProcessor.capturePayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3287, + "name": "PaymentProcessor.capturePayment" + } + }, + { + "id": 3323, + "name": "authorizePayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3324, + "name": "authorizePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to authorize payment using the Payment Session of an order. This is called when the\n[cart is completed](https://docs.medusajs.com/api/store#carts_postcartscartcomplete) and before the order is created.\n\nThis method is also used for authorizing payments of a swap of an order and when authorizing sessions in a payment collection.\nYou can interact with a third-party provider and perform any actions necessary to authorize the payment.\n\nThe payment authorization might require additional action from the customer before it is declared authorized. Once that additional action is performed,\nthe " + }, + { + "kind": "code", + "text": "`authorizePayment`" + }, + { + "kind": "text", + "text": " method will be called again to validate that the payment is now fully authorized. So, make sure to implement it for this case as well, if necessary.\n\nOnce the payment is authorized successfully and the Payment Session status is set to " + }, + { + "kind": "code", + "text": "`authorized`" + }, + { + "kind": "text", + "text": ", the associated order or swap can then be placed or created.\nIf the payment authorization fails, then an error will be thrown and the order will not be created.\n\n:::note\n\nThe payment authorization status is determined using the " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "getPaymentStatus", + "target": 3299, + "tsLinkText": "" + }, + { + "kind": "text", + "text": " method. If the status is " + }, + { + "kind": "code", + "text": "`requires_more`" + }, + { + "kind": "text", + "text": ", then it means additional actions are required\nfrom the customer. If you try to create the order with a status that isn't " + }, + { + "kind": "code", + "text": "`authorized`" + }, + { + "kind": "text", + "text": ", the process will fail.\n\n:::" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The authorization details or an error object." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError,\n PaymentSessionStatus,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async authorizePayment(\n paymentSessionData: Record,\n context: Record\n ): Promise<\n PaymentProcessorError |\n {\n status: PaymentSessionStatus;\n data: Record;\n }\n > {\n try {\n await this.client.authorize(paymentSessionData.id)\n\n return {\n status: PaymentSessionStatus.AUTHORIZED,\n data: {\n id: paymentSessionData.id\n }\n }\n } catch (e) {\n return {\n error: e.message\n }\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3325, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the payment session." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3326, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context of the authorization. It may include some of the following fields:\n\n- " + }, + { + "kind": "code", + "text": "`ip`" + }, + { + "kind": "text", + "text": ": The customer’s IP.\n- " + }, + { + "kind": "code", + "text": "`idempotency_key`" + }, + { + "kind": "text", + "text": ": The [Idempotency Key](https://docs.medusajs.com/modules/carts-and-checkout/payment#idempotency-key) that is associated with the current cart. It is useful when retrying payments, retrying checkout at a failed point, or for payments that require additional actions from the customer.\n- " + }, + { + "kind": "code", + "text": "`cart_id`" + }, + { + "kind": "text", + "text": ": The ID of a cart. This is only during operations like placing an order or creating a swap." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 3327, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3328, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSessionStatus" + }, + "name": "PaymentSessionStatus", + "package": "@medusajs/medusa" + } + }, + { + "id": 3329, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3328, + 3329 + ] + } + ] + } + } + ] + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3281, + "name": "PaymentProcessor.authorizePayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3280, + "name": "PaymentProcessor.authorizePayment" + } + }, + { + "id": 3330, + "name": "cancelPayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3331, + "name": "cancelPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to cancel an order’s payment. This method is typically triggered by one of the following situations:\n\n1. Before an order is placed and after the payment is authorized, an inventory check is done on products to ensure that products are still available for purchase. If the inventory check fails for any of the products, the payment is canceled.\n2. If the store operator cancels the order from the admin.\n3. When the payment of an order's swap is canceled.\n\nYou can utilize this method to interact with the third-party provider and perform any actions necessary to cancel the payment." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Either an error object or a value that's stored in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async cancelPayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n const cancelData = this.client.cancel(paymentId)\n\n return {\n id: paymentId,\n ...cancelData\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3332, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3297, + "name": "PaymentProcessor.cancelPayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3296, + "name": "PaymentProcessor.cancelPayment" + } + }, + { + "id": 3333, + "name": "initiatePayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3334, + "name": "initiatePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is called either if a region has only one payment provider enabled or when [a Payment Session is selected](https://docs.medusajs.com/api/store#carts_postcartscartpaymentsession),\nwhich occurs when the customer selects their preferred payment method during checkout.\n\nIt is used to allow you to make any necessary calls to the third-party provider to initialize the payment. For example, in Stripe this method is used to create a Payment Intent for the customer." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Either the payment's data or an error object." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentContext,\n PaymentSessionResponse,\n // ...\n} from \"@medusajs/medusa\"\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async initiatePayment(\n context: PaymentProcessorContext\n ): Promise<\n PaymentProcessorError | PaymentProcessorSessionResponse\n > {\n // assuming client is an initialized client\n // communicating with a third-party service.\n const clientPayment = await this.client.initiate(context)\n\n return {\n session_data: {\n id: clientPayment.id\n },\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3335, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context of the payment." + } + ] + }, + "type": { + "type": "reference", + "target": 3249, + "name": "PaymentProcessorContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3258, + "name": "PaymentProcessorSessionResponse", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3271, + "name": "PaymentProcessor.initiatePayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3270, + "name": "PaymentProcessor.initiatePayment" + } + }, + { + "id": 3336, + "name": "deletePayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3337, + "name": "deletePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to perform any actions necessary before a Payment Session is deleted. The Payment Session is deleted in one of the following cases:\n\n1. When a request is sent to [delete the Payment Session](https://docs.medusajs.com/api/store#carts_deletecartscartpaymentsessionssession).\n2. When the [Payment Session is refreshed](https://docs.medusajs.com/api/store#carts_postcartscartpaymentsessionssession). The Payment Session is deleted so that a newer one is initialized instead.\n3. When the Payment Processor is no longer available. This generally happens when the store operator removes it from the available Payment Processor in the admin.\n4. When the region of the store is changed based on the cart information and the Payment Processor is not available in the new region." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Either an error object or an empty object." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async deletePayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n // assuming client is an initialized client\n // communicating with a third-party service.\n this.client.delete(paymentId)\n\n return {}\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3338, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment Session." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3291, + "name": "PaymentProcessor.deletePayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3290, + "name": "PaymentProcessor.deletePayment" + } + }, + { + "id": 3339, + "name": "getPaymentStatus", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3340, + "name": "getPaymentStatus", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to get the status of a Payment or a Payment Session. Its main usage is within the place order and create swap flows.\nIf the status returned is not " + }, + { + "kind": "code", + "text": "`authorized`" + }, + { + "kind": "text", + "text": " within these flows, then the payment is considered failed and an error will be thrown, stopping the flow from completion." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The status of the Payment or Payment Session." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentSessionStatus\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async getPaymentStatus(\n paymentSessionData: Record\n ): Promise {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n return await this.client.getStatus(paymentId) as PaymentSessionStatus\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3341, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of a Payment as a parameter. You can use this data to interact with the third-party provider to check the status of the payment if necessary." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSessionStatus" + }, + "name": "PaymentSessionStatus", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3300, + "name": "PaymentProcessor.getPaymentStatus" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3299, + "name": "PaymentProcessor.getPaymentStatus" + } + }, + { + "id": 3342, + "name": "refundPayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3343, + "name": "refundPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to refund an order’s payment. This is typically triggered manually by the store operator from the admin. The refund amount might be the total order amount or part of it.\n\nThis method is also used for refunding payments of a swap or a claim of an order, or when a request is sent to the [Refund Payment API Route](https://docs.medusajs.com/api/admin#payments_postpaymentspaymentrefunds).\n\nYou can utilize this method to interact with the third-party provider and perform any actions necessary to refund the payment." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Either an error object or a value that's stored in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the Payment." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async refundPayment(\n paymentSessionData: Record,\n refundAmount: number\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n const refundData = this.client.refund(paymentId, refundAmount)\n\n return {\n id: paymentId,\n ...refundData\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3344, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of a Payment." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3345, + "name": "refundAmount", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the amount to refund." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3277, + "name": "PaymentProcessor.refundPayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3276, + "name": "PaymentProcessor.refundPayment" + } + }, + { + "id": 3346, + "name": "retrievePayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3347, + "name": "retrievePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to provide a uniform way of retrieving the payment information from the third-party provider.\nFor example, in Stripe’s Payment Processor this method is used to retrieve the payment intent details from Stripe." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The payment's data, typically retrieved from a third-party provider." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async retrievePayment(\n paymentSessionData: Record\n ): Promise | PaymentProcessorError> {\n const paymentId = paymentSessionData.id\n\n // assuming client is an initialized client\n // communicating with a third-party service.\n return await this.client.retrieve(paymentId)\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3348, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of a Payment Session. Make sure to store in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field any necessary data that would allow you to retrieve the payment data from the third-party provider." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3294, + "name": "PaymentProcessor.retrievePayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3293, + "name": "PaymentProcessor.retrievePayment" + } + }, + { + "id": 3349, + "name": "updatePayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3350, + "name": "updatePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to update the payment session when the payment amount changes. It's called whenever the cart or any of its related data is updated.\nFor example, when a [line item is added to the cart](https://docs.medusajs.com/api/store#carts_postcartscartlineitems) or when a\n[shipping method is selected](https://docs.medusajs.com/api/store#carts_postcartscartshippingmethod)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Either the payment's data or an error object." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorContext,\n PaymentProcessorError,\n PaymentProcessorSessionResponse,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n // ...\n async updatePayment(\n context: PaymentProcessorContext\n ): Promise<\n void |\n PaymentProcessorError |\n PaymentProcessorSessionResponse\n > {\n // assuming client is an initialized client\n // communicating with a third-party service.\n const paymentId = context.paymentSessionData.id\n\n await this.client.update(paymentId, context)\n\n return {\n session_data: context.paymentSessionData\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3351, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context of the payment." + } + ] + }, + "type": { + "type": "reference", + "target": 3249, + "name": "PaymentProcessorContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3258, + "name": "PaymentProcessorSessionResponse", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3274, + "name": "PaymentProcessor.updatePayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3273, + "name": "PaymentProcessor.updatePayment" + } + }, + { + "id": 3352, + "name": "updatePaymentData", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3353, + "name": "updatePaymentData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to update the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of a payment session. It's called when a request is sent to the\n[Update Payment Session API Route](https://docs.medusajs.com/api/store#carts_postcartscartpaymentsessionupdate), or when the " + }, + { + "kind": "code", + "text": "`CartService`" + }, + { + "kind": "text", + "text": "'s " + }, + { + "kind": "code", + "text": "`updatePaymentSession`" + }, + { + "kind": "text", + "text": " is used.\n\nThis method can also be used to update the data in the third-party payment provider, if necessary." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the data to store in the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " field of the payment session.\nYou can keep the data as-is, or make changes to it by communicating with the third-party provider." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n PaymentProcessorError,\n PaymentProviderService,\n // ...\n} from \"@medusajs/medusa\"\n// ...\n\nclass MyPaymentService extends AbstractPaymentProcessor {\n protected paymentProviderService: PaymentProviderService\n // ...\n constructor(container, options) {\n super(container)\n this.paymentProviderService = container.paymentProviderService\n // ...\n }\n // ...\n async updatePaymentData(\n sessionId: string,\n data: Record\n ): Promise<\n Record |\n PaymentProcessorError\n > {\n const paymentSession = await this.paymentProviderService.retrieveSession(sessionId)\n // assuming client is an initialized client\n // communicating with a third-party service.\n const clientPayment = await this.client.update(paymentSession.data.id, data)\n\n return {\n id: clientPayment.id\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3354, + "name": "sessionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the payment session." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3355, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to be updated in the payment session." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3303, + "name": "PaymentProcessor.updatePaymentData" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3302, + "name": "PaymentProcessor.updatePaymentData" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3312 + ] + }, + { + "title": "Properties", + "children": [ + 3316, + 3317, + 3307, + 3311 + ] + }, + { + "title": "Methods", + "children": [ + 3308, + 3320, + 3323, + 3330, + 3333, + 3336, + 3339, + 3342, + 3346, + 3349, + 3352 + ] + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 3267, + "name": "PaymentProcessor", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 3246, + "name": "isPaymentProcessorError", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3247, + "name": "isPaymentProcessorError", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3248, + "name": "obj", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "predicate", + "name": "obj", + "asserts": false, + "targetType": { + "type": "reference", + "target": 3263, + "name": "PaymentProcessorError", + "package": "@medusajs/medusa" + } + } + } + ] + }, + { + "id": 3356, + "name": "Data", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3357, + "name": "PaymentData", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + }, + { + "id": 3358, + "name": "PaymentSessionData", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + }, + { + "id": 3359, + "name": "PaymentContext", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 3360, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3361, + "name": "cart", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 3362, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3363, + "name": "context", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3364, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3365, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3366, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/address.ts", + "qualifiedName": "Address" + }, + "name": "Address", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 3367, + "name": "shipping_methods", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", + "qualifiedName": "ShippingMethod" + }, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3368, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/address.ts", + "qualifiedName": "Address" + }, + "name": "Address", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3363, + 3364, + 3365, + 3366, + 3367, + 3368 + ] + } + ] + } + } + }, + { + "id": 3369, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3370, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3371, + "name": "resource_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3372, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A customer can make purchases in your store and manage their profile." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + }, + { + "id": 3373, + "name": "paymentSessionData", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3361, + 3369, + 3370, + 3371, + 3372, + 3373 + ] + } + ] + } + } + }, + { + "id": 3374, + "name": "PaymentSessionResponse", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 3375, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3376, + "name": "update_requests", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 3377, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3378, + "name": "customer_metadata", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3378 + ] + } + ] + } + } + }, + { + "id": 3379, + "name": "session_data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3376, + 3379 + ] + } + ] + } + } + }, + { + "id": 3380, + "name": "PaymentService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use the new PaymentProcessor interface instead" + } + ] + } + ] + }, + "children": [ + { + "id": 3381, + "name": "getIdentifier", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3382, + "name": "getIdentifier", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 3383, + "name": "getPaymentData", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3384, + "name": "getPaymentData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use PaymentProcessor.retrievePayment instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3385, + "name": "paymentSession", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSession" + }, + "name": "PaymentSession", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3386, + "name": "updatePaymentData", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3387, + "name": "updatePaymentData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use PaymentProcessor.updatePayment instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3388, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + }, + { + "id": 3389, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3390, + "name": "createPayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3391, + "name": "createPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use PaymentProcessor.initiatePayment instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3392, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of this argument is meant to be temporary and once the previous method signature\nwill be removed, the type will only be PaymentContext instead of Cart & PaymentContext" + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3359, + "name": "PaymentContext", + "package": "@medusajs/medusa" + } + ] + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3374, + "name": "PaymentSessionResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 3393, + "name": "createPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use createPayment(context: " + }, + { + "kind": "code", + "text": "`Cart & PaymentContext): Promise`" + }, + { + "kind": "text", + "text": " instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3394, + "name": "cart", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3395, + "name": "retrievePayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3396, + "name": "retrievePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use PaymentProcessor.retrievePayment instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3397, + "name": "paymentData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3398, + "name": "updatePayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3399, + "name": "updatePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3400, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + }, + { + "id": 3401, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3359, + "name": "PaymentContext", + "package": "@medusajs/medusa" + } + ] + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": 3374, + "name": "PaymentSessionResponse", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 3402, + "name": "updatePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use PaymentProcessor.updatePayment instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3403, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + }, + { + "id": 3404, + "name": "cart", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3405, + "name": "authorizePayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3406, + "name": "authorizePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use PaymentProcessor.authorizePayment instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3407, + "name": "paymentSession", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSession" + }, + "name": "PaymentSession", + "package": "@medusajs/medusa" + } + }, + { + "id": 3408, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 3409, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3410, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + }, + { + "id": 3411, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSessionStatus" + }, + "name": "PaymentSessionStatus", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3410, + 3411 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3412, + "name": "capturePayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3413, + "name": "capturePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use PaymentProcessor.capturePayment instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3414, + "name": "payment", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment.ts", + "qualifiedName": "Payment" + }, + "name": "Payment", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3415, + "name": "refundPayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3416, + "name": "refundPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use PaymentProcessor.refundPayment instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3417, + "name": "payment", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment.ts", + "qualifiedName": "Payment" + }, + "name": "Payment", + "package": "@medusajs/medusa" + } + }, + { + "id": 3418, + "name": "refundAmount", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3419, + "name": "cancelPayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3420, + "name": "cancelPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use PaymentProcessor.cancelPayment instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3421, + "name": "payment", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment.ts", + "qualifiedName": "Payment" + }, + "name": "Payment", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3422, + "name": "deletePayment", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3423, + "name": "deletePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use PaymentProcessor.cancelPayment instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3424, + "name": "paymentSession", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSession" + }, + "name": "PaymentSession", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3425, + "name": "retrieveSavedMethods", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3426, + "name": "retrieveSavedMethods", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use PaymentProcessor.getSavedMethods instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3427, + "name": "customer", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3428, + "name": "getStatus", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3429, + "name": "getStatus", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use PaymentProcessor.getPaymentStatus instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3430, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSessionStatus" + }, + "name": "PaymentSessionStatus", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3431, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 3432, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 3433, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 3434, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + } + }, + { + "id": 3435, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 3436, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 3437, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 3438, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3439, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3440, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + } + }, + { + "id": 3441, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3442, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3443, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 3444, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3445, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3445 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + }, + { + "id": 3446, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3447, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 3448, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3449, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 3450, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3451, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3452, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3453, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 3454, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 3455, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3456, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3457, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 3458, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3459, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3460, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3461, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3431, + 3432, + 3435, + 3436, + 3437 + ] + }, + { + "title": "Accessors", + "children": [ + 3433 + ] + }, + { + "title": "Methods", + "children": [ + 3381, + 3383, + 3386, + 3390, + 3395, + 3398, + 3405, + 3412, + 3415, + 3419, + 3422, + 3425, + 3428, + 3438, + 3441, + 3446 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 3462, + "name": "AbstractPaymentService", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use the AbstractPaymentProcessor instead" + } + ] + } + ] + }, + "children": [ + { + "id": 3463, + "name": "_isPaymentService", + "variant": "declaration", + "kind": 1024, + "flags": { + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": "true" + }, + { + "id": 3468, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3469, + "name": "new AbstractPaymentService", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 3470, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 3471, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 3462, + "name": "AbstractPaymentService", + "package": "@medusajs/medusa" + }, + "overwrites": { + "type": "reference", + "target": 3769, + "name": "TransactionBaseService.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": 3768, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 3467, + "name": "identifier", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true, + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3472, + "name": "getIdentifier", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true + }, + "signatures": [ + { + "id": 3473, + "name": "getIdentifier", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.getIdentifier" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.getIdentifier" + } + }, + { + "id": 3474, + "name": "getPaymentData", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3475, + "name": "getPaymentData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] + } + ] + }, + "parameters": [ + { + "id": 3476, + "name": "paymentSession", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSession" + }, + "name": "PaymentSession", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.getPaymentData" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.getPaymentData" + } + }, + { + "id": 3477, + "name": "updatePaymentData", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3478, + "name": "updatePaymentData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] + } + ] + }, + "parameters": [ + { + "id": 3479, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + }, + { + "id": 3480, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.updatePaymentData" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.updatePaymentData" + } + }, + { + "id": 3481, + "name": "createPayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3482, + "name": "createPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3483, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of this argument is meant to be temporary and once the previous method signature\nwill be removed, the type will only be PaymentContext instead of Cart & PaymentContext" + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3359, + "name": "PaymentContext", + "package": "@medusajs/medusa" + } + ] + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3374, + "name": "PaymentSessionResponse", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.createPayment" + } + }, + { + "id": 3484, + "name": "createPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use " + }, + { + "kind": "code", + "text": "`createPayment(context: Cart & PaymentContext): Promise`" + }, + { + "kind": "text", + "text": " instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3485, + "name": "cart", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.createPayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.createPayment" + } + }, + { + "id": 3486, + "name": "retrievePayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3487, + "name": "retrievePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] + } + ] + }, + "parameters": [ + { + "id": 3488, + "name": "paymentData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.retrievePayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.retrievePayment" + } + }, + { + "id": 3489, + "name": "updatePayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3490, + "name": "updatePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "it return either a PaymentSessionResponse or PaymentSessionResponse[\"session_data\"] to maintain backward compatibility" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3491, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + }, + { + "id": 3492, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of this argument is meant to be temporary and once the previous method signature\nwill be removed, the type will only be PaymentContext instead of Cart & PaymentContext" + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3359, + "name": "PaymentContext", + "package": "@medusajs/medusa" + } + ] + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reference", + "target": 3374, + "name": "PaymentSessionResponse", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.updatePayment" + } + }, + { + "id": 3493, + "name": "updatePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future use " + }, + { + "kind": "code", + "text": "`updatePayment(paymentSessionData: PaymentSessionData, context: Cart & PaymentContext): Promise`" + }, + { + "kind": "text", + "text": " instead" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3494, + "name": "paymentSessionData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + }, + { + "id": 3495, + "name": "cart", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/cart.ts", + "qualifiedName": "Cart" + }, + "name": "Cart", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.updatePayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.updatePayment" + } + }, + { + "id": 3496, + "name": "authorizePayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3497, + "name": "authorizePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", + "content": [] + } + ] + }, + "parameters": [ + { + "id": 3498, + "name": "paymentSession", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSession" + }, + "name": "PaymentSession", + "package": "@medusajs/medusa" + } + }, + { + "id": 3499, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reflection", + "declaration": { + "id": 3500, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3501, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + }, + { + "id": 3502, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSessionStatus" + }, + "name": "PaymentSessionStatus", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3501, + 3502 + ] + } + ] + } + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.authorizePayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.authorizePayment" + } + }, + { + "id": 3503, + "name": "capturePayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3504, + "name": "capturePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3505, + "name": "payment", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment.ts", + "qualifiedName": "Payment" + }, + "name": "Payment", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.capturePayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.capturePayment" + } + }, + { + "id": 3506, + "name": "refundPayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3507, + "name": "refundPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3508, + "name": "payment", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment.ts", + "qualifiedName": "Payment" + }, + "name": "Payment", + "package": "@medusajs/medusa" + } + }, + { + "id": 3509, + "name": "refundAmount", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.refundPayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.refundPayment" + } + }, + { + "id": 3510, + "name": "cancelPayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3511, + "name": "cancelPayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3512, + "name": "payment", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment.ts", + "qualifiedName": "Payment" + }, + "name": "Payment", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.cancelPayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.cancelPayment" + } + }, + { + "id": 3513, + "name": "deletePayment", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3514, + "name": "deletePayment", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3515, + "name": "paymentSession", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSession" + }, + "name": "PaymentSession", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.deletePayment" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.deletePayment" + } + }, + { + "id": 3516, + "name": "retrieveSavedMethods", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true + }, + "signatures": [ + { + "id": 3517, + "name": "retrieveSavedMethods", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3518, + "name": "customer", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A customer can make purchases in your store and manage their profile." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.retrieveSavedMethods" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.retrieveSavedMethods" + } + }, + { + "id": 3519, + "name": "getStatus", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3520, + "name": "getStatus", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This will be" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "in the near future" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3521, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 3356, + "name": "Data", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-session.ts", + "qualifiedName": "PaymentSessionStatus" + }, + "name": "PaymentSessionStatus", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.getStatus" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.getStatus" + } + }, + { + "id": 3522, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.manager_" + } + }, + { + "id": 3523, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.transactionManager_" + } + }, + { + "id": 3524, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 3525, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.activeManager_" + } + }, + { + "id": 3526, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.__container__" + } + }, + { + "id": 3527, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.__configModule__" + } + }, + { + "id": 3528, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.__moduleDeclaration__" + } + }, + { + "id": 3529, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3530, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3531, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.withTransaction" + } + }, + { + "id": 3532, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3533, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3534, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 3535, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3536, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3536 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.shouldRetryTransaction_" + } + }, + { + "id": 3537, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3538, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 3539, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3540, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 3541, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3542, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3543, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3544, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 3545, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 3546, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3547, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3548, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 3549, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3550, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3551, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3552, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "PaymentService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3468 + ] + }, + { + "title": "Properties", + "children": [ + 3463, + 3467, + 3522, + 3523, + 3526, + 3527, + 3528 + ] + }, + { + "title": "Accessors", + "children": [ + 3524 + ] + }, + { + "title": "Methods", + "children": [ + 3472, + 3474, + 3477, + 3481, + 3486, + 3489, + 3496, + 3503, + 3506, + 3510, + 3513, + 3516, + 3519, + 3529, + 3532, + 3537 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 4894, + "name": "\"medusa-interfaces\"", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 3553, + "name": "IPriceSelectionStrategy", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\nThe price selection strategy retrieves the best price for a product variant for a specific context such as selected region, taxes applied,\nthe quantity in cart, and more.\n\nMedusa provides a default price selection strategy, but you can override it. A price selecion strategy is a TypeScript or JavaScript file in the " + }, + { + "kind": "code", + "text": "`src/strategies`" + }, + { + "kind": "text", + "text": " directory of your Medusa backend project. It exports a class that extends the " + }, + { + "kind": "code", + "text": "`AbstractPriceSelectionStrategy`" + }, + { + "kind": "text", + "text": " class.\n\nFor example:\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/strategies/price.ts\"\nimport {\n AbstractPriceSelectionStrategy,\n PriceSelectionContext,\n PriceSelectionResult,\n} from \"@medusajs/medusa\"\n\nexport default class MyStrategy extends\n AbstractPriceSelectionStrategy {\n\n async calculateVariantPrice(\n data: {\n variantId: string;\n quantity?: number\n }[],\n context: PriceSelectionContext\n ): Promise> {\n throw new Error(\"Method not implemented.\")\n }\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---" + } + ] + }, + "children": [ + { + "id": 3554, + "name": "calculateVariantPrice", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3555, + "name": "calculateVariantPrice", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves one or more product variants' prices. It's used when retrieving product variants or their associated line items.\nIt's also used when retrieving other entities that product variants and line items belong to, such as products and carts respectively." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A map, each key is an ID of a variant, and its value is an object holding the price selection result." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, here's a snippet of how the price selection strategy is implemented in the Medusa backend:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport {\n AbstractPriceSelectionStrategy,\n CustomerService,\n PriceSelectionContext,\n PriceSelectionResult,\n} from \"@medusajs/medusa\"\n\ntype InjectedDependencies = {\n customerService: CustomerService\n}\n\nexport default class MyStrategy extends\n AbstractPriceSelectionStrategy {\n\n async calculateVariantPrice(\n data: {\n variantId: string\n quantity?: number\n }[],\n context: PriceSelectionContext\n ): Promise> {\n const dataMap = new Map(data.map((d) => [d.variantId, d]))\n\n const cacheKeysMap = new Map(\n data.map(({ variantId, quantity }) => [\n variantId,\n this.getCacheKey(variantId, { ...context, quantity }),\n ])\n )\n\n const nonCachedData: {\n variantId: string\n quantity?: number\n }[] = []\n\n const variantPricesMap = new Map()\n\n if (!context.ignore_cache) {\n const cacheHits = await promiseAll(\n [...cacheKeysMap].map(async ([, cacheKey]) => {\n return await this.cacheService_.get(cacheKey)\n })\n )\n\n if (!cacheHits.length) {\n nonCachedData.push(...dataMap.values())\n }\n\n for (const [index, cacheHit] of cacheHits.entries()) {\n const variantId = data[index].variantId\n if (cacheHit) {\n variantPricesMap.set(variantId, cacheHit)\n continue\n }\n\n nonCachedData.push(dataMap.get(variantId)!)\n }\n } else {\n nonCachedData.push(...dataMap.values())\n }\n\n let results: Map = new Map()\n\n if (\n this.featureFlagRouter_.isFeatureEnabled(\n TaxInclusivePricingFeatureFlag.key\n )\n ) {\n results = await this.calculateVariantPrice_new(nonCachedData, context)\n } else {\n results = await this.calculateVariantPrice_old(nonCachedData, context)\n }\n\n await promiseAll(\n [...results].map(async ([variantId, prices]) => {\n variantPricesMap.set(variantId, prices)\n if (!context.ignore_cache) {\n await this.cacheService_.set(cacheKeysMap.get(variantId)!, prices)\n }\n })\n )\n\n return variantPricesMap\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3556, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The necessary data to perform the price selection for each variant ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 3557, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3558, + "name": "variantId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the variant to retrieve its prices." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3559, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The variant's quantity in the cart, if available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3558, + 3559 + ] + } + ] + } + } + } + }, + { + "id": 3560, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context of the price selection." + } + ] + }, + "type": { + "type": "reference", + "target": 3620, + "name": "PriceSelectionContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es2015.collection.d.ts", + "qualifiedName": "Map" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 3635, + "name": "PriceSelectionResult", + "package": "@medusajs/medusa" + } + ], + "name": "Map", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3561, + "name": "onVariantsPricesUpdate", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3562, + "name": "onVariantsPricesUpdate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is called when prices of product variants have changed.\nYou can use it to invalidate prices stored in the cache." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Resolves after any necessary actions are performed." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, this is how this method is implemented in the Medusa backend's default\nprice selection strategy:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport {\n AbstractPriceSelectionStrategy,\n CustomerService,\n} from \"@medusajs/medusa\"\nimport { promiseAll } from \"@medusajs/utils\"\n\ntype InjectedDependencies = {\n customerService: CustomerService\n}\n\nexport default class MyStrategy extends\n AbstractPriceSelectionStrategy {\n\n public async onVariantsPricesUpdate(variantIds: string[]): Promise {\n await promiseAll(\n variantIds.map(\n async (id: string) => await this.cacheService_.invalidate(`ps:${id}:*`)\n )\n )\n }\n\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::note\n\nLearn more about the cache service in [this documentation](https://docs.medusajs.com/development/cache/overview).\n\n:::" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3563, + "name": "variantIds", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the updated variants." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 3564, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3565, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3566, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 4897, + "name": "ITransactionBaseService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4896, + "name": "ITransactionBaseService.withTransaction" + } + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 3554, + 3561, + 3564 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4895, + "name": "ITransactionBaseService", + "package": "@medusajs/types" + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 3567, + "name": "AbstractPriceSelectionStrategy" + } + ] + }, + { + "id": 3567, + "name": "AbstractPriceSelectionStrategy", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 3572, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3573, + "name": "new AbstractPriceSelectionStrategy", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your price-selection strategy to access the different services in Medusa through dependency injection." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport {\n AbstractPriceSelectionStrategy,\n CustomerService,\n} from \"@medusajs/medusa\"\ntype InjectedDependencies = {\n customerService: CustomerService\n}\n\nclass MyStrategy extends\n AbstractPriceSelectionStrategy {\n\n protected customerService_: CustomerService\n\n constructor(container: InjectedDependencies) {\n super(container)\n this.customerService_ = container.customerService\n }\n\n // ...\n}\n\nexport default MyStrategy\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3574, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 3575, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this price-selection strategy is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 3567, + "name": "AbstractPriceSelectionStrategy", + "package": "@medusajs/medusa" + }, + "overwrites": { + "type": "reference", + "target": 3769, + "name": "TransactionBaseService.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": 3768, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 3576, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 3577, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this price-selection strategy is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3578, + "name": "calculateVariantPrice", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3579, + "name": "calculateVariantPrice", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves one or more product variants' prices. It's used when retrieving product variants or their associated line items.\nIt's also used when retrieving other entities that product variants and line items belong to, such as products and carts respectively." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A map, each key is an ID of a variant, and its value is an object holding the price selection result." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, here's a snippet of how the price selection strategy is implemented in the Medusa backend:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport {\n AbstractPriceSelectionStrategy,\n CustomerService,\n PriceSelectionContext,\n PriceSelectionResult,\n} from \"@medusajs/medusa\"\n\ntype InjectedDependencies = {\n customerService: CustomerService\n}\n\nexport default class MyStrategy extends\n AbstractPriceSelectionStrategy {\n\n async calculateVariantPrice(\n data: {\n variantId: string\n quantity?: number\n }[],\n context: PriceSelectionContext\n ): Promise> {\n const dataMap = new Map(data.map((d) => [d.variantId, d]))\n\n const cacheKeysMap = new Map(\n data.map(({ variantId, quantity }) => [\n variantId,\n this.getCacheKey(variantId, { ...context, quantity }),\n ])\n )\n\n const nonCachedData: {\n variantId: string\n quantity?: number\n }[] = []\n\n const variantPricesMap = new Map()\n\n if (!context.ignore_cache) {\n const cacheHits = await promiseAll(\n [...cacheKeysMap].map(async ([, cacheKey]) => {\n return await this.cacheService_.get(cacheKey)\n })\n )\n\n if (!cacheHits.length) {\n nonCachedData.push(...dataMap.values())\n }\n\n for (const [index, cacheHit] of cacheHits.entries()) {\n const variantId = data[index].variantId\n if (cacheHit) {\n variantPricesMap.set(variantId, cacheHit)\n continue\n }\n\n nonCachedData.push(dataMap.get(variantId)!)\n }\n } else {\n nonCachedData.push(...dataMap.values())\n }\n\n let results: Map = new Map()\n\n if (\n this.featureFlagRouter_.isFeatureEnabled(\n TaxInclusivePricingFeatureFlag.key\n )\n ) {\n results = await this.calculateVariantPrice_new(nonCachedData, context)\n } else {\n results = await this.calculateVariantPrice_old(nonCachedData, context)\n }\n\n await promiseAll(\n [...results].map(async ([variantId, prices]) => {\n variantPricesMap.set(variantId, prices)\n if (!context.ignore_cache) {\n await this.cacheService_.set(cacheKeysMap.get(variantId)!, prices)\n }\n })\n )\n\n return variantPricesMap\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3580, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The necessary data to perform the price selection for each variant ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 3581, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3582, + "name": "variantId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3584, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3582, + 3584 + ] + } + ] + } + } + } + }, + { + "id": 3585, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context of the price selection." + } + ] + }, + "type": { + "type": "reference", + "target": 3620, + "name": "PriceSelectionContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es2015.collection.d.ts", + "qualifiedName": "Map" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 3635, + "name": "PriceSelectionResult", + "package": "@medusajs/medusa" + } + ], + "name": "Map", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3555, + "name": "IPriceSelectionStrategy.calculateVariantPrice" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3554, + "name": "IPriceSelectionStrategy.calculateVariantPrice" + } + }, + { + "id": 3586, + "name": "onVariantsPricesUpdate", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true + }, + "signatures": [ + { + "id": 3587, + "name": "onVariantsPricesUpdate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is called when prices of product variants have changed.\nYou can use it to invalidate prices stored in the cache." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Resolves after any necessary actions are performed." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, this is how this method is implemented in the Medusa backend's default\nprice selection strategy:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport {\n AbstractPriceSelectionStrategy,\n CustomerService,\n} from \"@medusajs/medusa\"\nimport { promiseAll } from \"@medusajs/utils\"\n\ntype InjectedDependencies = {\n customerService: CustomerService\n}\n\nexport default class MyStrategy extends\n AbstractPriceSelectionStrategy {\n\n public async onVariantsPricesUpdate(variantIds: string[]): Promise {\n await promiseAll(\n variantIds.map(\n async (id: string) => await this.cacheService_.invalidate(`ps:${id}:*`)\n )\n )\n }\n\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::note\n\nLearn more about the cache service in [this documentation](https://docs.medusajs.com/development/cache/overview).\n\n:::" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3588, + "name": "variantIds", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the updated variants." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3562, + "name": "IPriceSelectionStrategy.onVariantsPricesUpdate" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3561, + "name": "IPriceSelectionStrategy.onVariantsPricesUpdate" + } + }, + { + "id": 3589, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 3590, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 3591, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 3592, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + } + }, + { + "id": 3593, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 3594, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 3595, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 3596, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3597, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3598, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + }, + "implementationOf": { + "type": "reference", + "target": 3565, + "name": "IPriceSelectionStrategy.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + }, + "implementationOf": { + "type": "reference", + "target": 3564, + "name": "IPriceSelectionStrategy.withTransaction" + } + }, + { + "id": 3599, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3600, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3601, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 3602, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3603, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3603 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + }, + { + "id": 3604, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3605, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 3606, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3607, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 3608, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3609, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3610, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3611, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 3612, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 3613, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3614, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3615, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 3616, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3617, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3618, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3619, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3572 + ] + }, + { + "title": "Properties", + "children": [ + 3576, + 3577, + 3589, + 3590, + 3593, + 3594, + 3595 + ] + }, + { + "title": "Accessors", + "children": [ + 3591 + ] + }, + { + "title": "Methods", + "children": [ + 3578, + 3586, + 3596, + 3599, + 3604 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 3553, + "name": "IPriceSelectionStrategy", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 3620, + "name": "PriceSelectionContext", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context of the price selection." + } + ] + }, + "children": [ + { + "id": 3621, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID. This is used when the prices are being retrieved for the variant of a line item,\nas it is used to determine the current region and currency code of the context." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3622, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the customer viewing the variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3623, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3624, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the item in the cart. This is used to filter out price lists that have\n" + }, + { + "kind": "code", + "text": "`min_quantity`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`max_quantity`" + }, + { + "kind": "text", + "text": " conditions set." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3625, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currency code the customer is using." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3626, + "name": "include_discount_prices", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the price list's prices should be retrieved or not." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 3627, + "name": "tax_rates", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rates to be applied. This is only used for\n[Tax-Inclusive Pricing](https://docs.medusajs.com/modules/taxes/inclusive-pricing)." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4899, + "name": "TaxServiceRate", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3628, + "name": "ignore_cache", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to calculate the prices even if the value of an earlier price calculation\nis available in the cache." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3621, + 3622, + 3623, + 3624, + 3625, + 3626, + 3627, + 3628 + ] + } + ] + }, + { + "id": 4905, + "name": "DefaultPriceType", + "variant": "declaration", + "kind": 8, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of default price type." + } + ] + } + }, + { + "id": 4904, + "name": "DEFAULT", + "variant": "declaration", + "kind": 16, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`calculatedPrice`" + }, + { + "kind": "text", + "text": " is the original price." + } + ] + }, + "type": { + "type": "literal", + "value": "default" + } + }, + { + "id": 3629, + "name": "PriceType", + "variant": "declaration", + "kind": 32, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 3630, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3633, + "name": "DEFAULT", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 4904, + "name": "DEFAULT", + "package": "@medusajs/medusa", + "qualifiedName": "DefaultPriceType.DEFAULT" + }, + "defaultValue": "\"default\"" + }, + { + "id": 3631, + "name": "SALE", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 4069, + "name": "SALE", + "package": "@medusajs/medusa", + "qualifiedName": "PriceListType.SALE" + }, + "defaultValue": "\"sale\"" + }, + { + "id": 3632, + "name": "OVERRIDE", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 4070, + "name": "OVERRIDE", + "package": "@medusajs/medusa", + "qualifiedName": "PriceListType.OVERRIDE" + }, + "defaultValue": "\"override\"" + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3633, + 3631, + 3632 + ] + } + ] + } + } + }, + { + "id": 3634, + "name": "PriceType", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 4905, + "name": "DefaultPriceType", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 4068, + "name": "PriceListType", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 3635, + "name": "PriceSelectionResult", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price selection result of a variant." + } + ] + }, + "children": [ + { + "id": 3636, + "name": "originalPrice", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The original price of the variant which depends on the selected region or currency code in the context object.\nIf both region ID and currency code are available in the context object, the region has higher precedence." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 3637, + "name": "originalPriceIncludesTax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the original price includes taxes or not. This is only available\nfor [Tax-Inclusive Pricing](https://docs.medusajs.com/modules/taxes/inclusive-pricing)." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + }, + { + "id": 3638, + "name": "calculatedPrice", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The lowest price among the prices of the product variant retrieved using the context object." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 3639, + "name": "calculatedPriceIncludesTax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the calculated price includes taxes or not.\nThis is only available for [Tax-Inclusive Pricing](https://docs.medusajs.com/modules/taxes/inclusive-pricing)." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + }, + { + "id": 3640, + "name": "calculatedPriceType", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of price applied in " + }, + { + "kind": "code", + "text": "`calculatedPrice`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "reference", + "target": 3634, + "name": "PriceType", + "package": "@medusajs/medusa" + } + }, + { + "id": 3641, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "All possible prices of the variant that are retrieved using the " + }, + { + "kind": "code", + "text": "`context`" + }, + { + "kind": "text", + "text": " object.\nIt can include its original price and its price lists if there are any." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", + "qualifiedName": "MoneyAmount" + }, + "name": "MoneyAmount", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3636, + 3637, + 3638, + 3639, + 3640, + 3641 + ] + } + ] + }, + { + "id": 3642, + "name": "ITaxCalculationStrategy", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\nA tax calculation strategy is used to calculate taxes when calculating a cart's totals. The Medusa\nbackend provides a tax calculation strategy that handles calculating the taxes, taking into account the\ndefined tax rates and settings such as whether tax-inclusive pricing is enabled.\n\nYou can override the tax calculation strategy to implement different calculation logic or to\nintegrate a third-party service that handles the tax calculation. You can override it either\nin a Medusa backend setup or in a plugin.\n\nA tax calculation strategy should be defined in a TypeScript or JavaScript file created under the " + }, + { + "kind": "code", + "text": "`src/strategies`" + }, + { + "kind": "text", + "text": " directory.\nThe class must also implement the " + }, + { + "kind": "code", + "text": "`ITaxCalculationStrategy`" + }, + { + "kind": "text", + "text": " interface imported from the " + }, + { + "kind": "code", + "text": "`@medusajs/medusa`" + }, + { + "kind": "text", + "text": " package.\n\nFor example, you can create the file " + }, + { + "kind": "code", + "text": "`src/strategies/tax-calculation.ts`" + }, + { + "kind": "text", + "text": " with the following content:\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/strategies/tax-calculation.ts\"\nimport {\n ITaxCalculationStrategy,\n LineItem,\n LineItemTaxLine,\n ShippingMethodTaxLine,\n TaxCalculationContext,\n} from \"@medusajs/medusa\"\n\nclass TaxCalculationStrategy\n implements ITaxCalculationStrategy {\n\n async calculate(\n items: LineItem[],\n taxLines: (ShippingMethodTaxLine | LineItemTaxLine)[],\n calculationContext: TaxCalculationContext\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n\n}\n\nexport default TaxCalculationStrategy\n```" + }, + { + "kind": "text", + "text": "\n\n---" + } + ] + }, + "children": [ + { + "id": 3643, + "name": "calculate", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3644, + "name": "calculate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method calculates the tax amount for a given set of line items under applicable\ntax conditions and calculation contexts.\n\nThis method is used whenever taxes are calculated. If automatic tax calculation is disabled in a region,\nthen it's only triggered when taxes are calculated manually as explained in\n[this guide](https://docs.medusajs.com/modules/taxes/storefront/manual-calculation)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The calculated tax total" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "An example of the general implementation of this method in the Medusa backend's tax calculation strategy:\n\n" + }, + { + "kind": "code", + "text": "```ts\nasync calculate(\n items: LineItem[],\n taxLines: (ShippingMethodTaxLine | LineItemTaxLine)[],\n calculationContext: TaxCalculationContext\n): Promise {\n const lineItemsTaxLines = taxLines.filter(\n (tl) => \"item_id\" in tl\n ) as LineItemTaxLine[]\n const shippingMethodsTaxLines = taxLines.filter(\n (tl) => \"shipping_method_id\" in tl\n ) as ShippingMethodTaxLine[]\n\n const lineItemsTax = this.calculateLineItemsTax(\n items,\n lineItemsTaxLines,\n calculationContext\n )\n\n const shippingMethodsTax = this.calculateShippingMethodsTax(\n calculationContext.shipping_methods,\n shippingMethodsTaxLines\n )\n\n return Math.round(lineItemsTax + shippingMethodsTax)\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3645, + "name": "items", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line items to calculate the tax total for." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", + "qualifiedName": "LineItem" + }, + "name": "LineItem", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3646, + "name": "taxLines", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax lines used for the calculation" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item-tax-line.ts", + "qualifiedName": "LineItemTaxLine" + }, + "name": "LineItemTaxLine", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-method-tax-line.ts", + "qualifiedName": "ShippingMethodTaxLine" + }, + "name": "ShippingMethodTaxLine", + "package": "@medusajs/medusa" + } + ] + } + } + }, + { + "id": 3647, + "name": "calculationContext", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Other details relevant for the calculation" + } + ] + }, + "type": { + "type": "reference", + "target": 3703, + "name": "TaxCalculationContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 3643 + ] + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 3648, + "name": "AbstractTaxCalculationStrategy" + } + ] + }, + { + "id": 3648, + "name": "AbstractTaxCalculationStrategy", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 3653, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3654, + "name": "new AbstractTaxCalculationStrategy", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your tax calculation strategy to access the different services in Medusa through dependency injection.\n\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the service.\nAdditionally, if you’re creating your tax calculation strategy as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, you can access it in the constructor." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n ITaxCalculationStrategy,\n LineItemService,\n} from \"@medusajs/medusa\"\n\ntype InjectedDependencies = {\n lineItemService: LineItemService\n}\n\nclass TaxCalculationStrategy\n implements ITaxCalculationStrategy {\n\n protected readonly lineItemService_: LineItemService\n\n constructor({ lineItemService }: InjectedDependencies) {\n this.lineItemService_ = lineItemService\n }\n\n // ...\n}\n\nexport default TaxCalculationStrategy\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3655, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 3656, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this tax calculation strategy is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 3648, + "name": "AbstractTaxCalculationStrategy", + "package": "@medusajs/medusa" + }, + "overwrites": { + "type": "reference", + "target": 3769, + "name": "TransactionBaseService.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": 3768, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 3657, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 3658, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this tax calculation strategy is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3659, + "name": "calculate", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 3660, + "name": "calculate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method calculates the tax amount for a given set of line items under applicable\ntax conditions and calculation contexts.\n\nThis method is used whenever taxes are calculated. If automatic tax calculation is disabled in a region,\nthen it's only triggered when taxes are calculated manually as explained in\n[this guide](https://docs.medusajs.com/modules/taxes/storefront/manual-calculation)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The calculated tax total" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "An example of the general implementation of this method in the Medusa backend's tax calculation strategy:\n\n" + }, + { + "kind": "code", + "text": "```ts\nasync calculate(\n items: LineItem[],\n taxLines: (ShippingMethodTaxLine | LineItemTaxLine)[],\n calculationContext: TaxCalculationContext\n): Promise {\n const lineItemsTaxLines = taxLines.filter(\n (tl) => \"item_id\" in tl\n ) as LineItemTaxLine[]\n const shippingMethodsTaxLines = taxLines.filter(\n (tl) => \"shipping_method_id\" in tl\n ) as ShippingMethodTaxLine[]\n\n const lineItemsTax = this.calculateLineItemsTax(\n items,\n lineItemsTaxLines,\n calculationContext\n )\n\n const shippingMethodsTax = this.calculateShippingMethodsTax(\n calculationContext.shipping_methods,\n shippingMethodsTaxLines\n )\n\n return Math.round(lineItemsTax + shippingMethodsTax)\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3661, + "name": "items", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line items to calculate the tax total for." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", + "qualifiedName": "LineItem" + }, + "name": "LineItem", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3662, + "name": "taxLines", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax lines used for the calculation" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item-tax-line.ts", + "qualifiedName": "LineItemTaxLine" + }, + "name": "LineItemTaxLine", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-method-tax-line.ts", + "qualifiedName": "ShippingMethodTaxLine" + }, + "name": "ShippingMethodTaxLine", + "package": "@medusajs/medusa" + } + ] + } + } + }, + { + "id": 3663, + "name": "calculationContext", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Other details relevant for the calculation" + } + ] + }, + "type": { + "type": "reference", + "target": 3703, + "name": "TaxCalculationContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3644, + "name": "ITaxCalculationStrategy.calculate" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3643, + "name": "ITaxCalculationStrategy.calculate" + } + }, + { + "id": 3664, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 3665, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 3666, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 3667, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + } + }, + { + "id": 3668, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 3669, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 3670, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 3671, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3672, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3673, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + } + }, + { + "id": 3674, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3675, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3676, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 3677, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3678, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3678 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + }, + { + "id": 3679, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3680, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 3681, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3682, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 3683, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3684, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3685, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3686, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 3687, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 3688, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3689, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3690, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 3691, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3692, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3693, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3694, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3653 + ] + }, + { + "title": "Properties", + "children": [ + 3657, + 3658, + 3664, + 3665, + 3668, + 3669, + 3670 + ] + }, + { + "title": "Accessors", + "children": [ + 3666 + ] + }, + { + "title": "Methods", + "children": [ + 3659, + 3671, + 3674, + 3679 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 3642, + "name": "ITaxCalculationStrategy", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 3695, + "name": "ShippingTaxCalculationLine", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A shipping method and the tax rates configured to apply to the\nshipping method." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3696, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3697, + "name": "shipping_method", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method to calculate taxes for." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", + "qualifiedName": "ShippingMethod" + }, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + }, + { + "id": 3698, + "name": "rates", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rates applicable on the shipping method." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4899, + "name": "TaxServiceRate", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3697, + 3698 + ] + } + ] + } + } + }, + { + "id": 3699, + "name": "ItemTaxCalculationLine", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A line item and the tax rates configured to apply to the\nproduct contained in the line item." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3700, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3701, + "name": "item", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item to calculate taxes for." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", + "qualifiedName": "LineItem" + }, + "name": "LineItem", + "package": "@medusajs/medusa" + } + }, + { + "id": 3702, + "name": "rates", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rates applicable on the item." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4899, + "name": "TaxServiceRate", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3701, + 3702 + ] + } + ] + } + } + }, + { + "id": 3703, + "name": "TaxCalculationContext", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Information relevant to a tax calculation, such as the shipping address where\nthe items are going." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3704, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3705, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping address used in the cart." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/address.ts", + "qualifiedName": "Address" + }, + "name": "Address", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 3706, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer that the cart belongs to." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + }, + { + "id": 3707, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's region." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/region.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + }, + { + "id": 3708, + "name": "is_return", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the cart is used in a return flow." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 3709, + "name": "shipping_methods", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping methods used in the cart." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", + "qualifiedName": "ShippingMethod" + }, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3710, + "name": "allocation_map", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The gift cards and discounts applied on line items.\nEach object key or property is an ID of a line item" + } + ] + }, + "type": { + "type": "reference", + "target": 4906, + "name": "LineAllocationsMap", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3705, + 3706, + 3707, + 3708, + 3709, + 3710 + ] + } + ] + } + } + }, + { + "id": 3711, + "name": "ITaxService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\nA tax provider is used to retrieve the tax lines in a cart. The Medusa backend provides a default " + }, + { + "kind": "code", + "text": "`system`" + }, + { + "kind": "text", + "text": " provider. You can create your own tax provider,\neither in a plugin or directly in your Medusa backend, then use it in any region.\n\nA tax provider class is defined in a TypeScript or JavaScript file under the " + }, + { + "kind": "code", + "text": "`src/services`" + }, + { + "kind": "text", + "text": " directory and the class must extend the\n" + }, + { + "kind": "code", + "text": "`AbstractTaxService`" + }, + { + "kind": "text", + "text": " class imported from " + }, + { + "kind": "code", + "text": "`@medusajs/medusa`" + }, + { + "kind": "text", + "text": ". The file's name is the tax provider's class name as a slug and without the word " + }, + { + "kind": "code", + "text": "`Service`" + }, + { + "kind": "text", + "text": ".\n\nFor example, you can create the file " + }, + { + "kind": "code", + "text": "`src/services/my-tax.ts`" + }, + { + "kind": "text", + "text": " with the following content:\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/services/my-tax.ts\"\nimport {\n AbstractTaxService,\n ItemTaxCalculationLine,\n ShippingTaxCalculationLine,\n TaxCalculationContext,\n} from \"@medusajs/medusa\"\nimport {\n ProviderTaxLine,\n} from \"@medusajs/medusa/dist/types/tax-service\"\n\nclass MyTaxService extends AbstractTaxService {\n async getTaxLines(\n itemLines: ItemTaxCalculationLine[],\n shippingLines: ShippingTaxCalculationLine[],\n context: TaxCalculationContext):\n Promise {\n throw new Error(\"Method not implemented.\")\n }\n}\n\nexport default MyTaxService\n```" + }, + { + "kind": "text", + "text": "\n\n---\n\n## Identifier Property\n\nThe " + }, + { + "kind": "code", + "text": "`TaxProvider`" + }, + { + "kind": "text", + "text": " entity has 2 properties: " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`is_installed`" + }, + { + "kind": "text", + "text": ". The " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " property in the tax provider service is used when the tax provider is added to the database.\n\nThe value of this property is also used to reference the tax provider throughout Medusa. For example, it is used to [change the tax provider](https://docs.medusajs.com/modules/taxes/admin/manage-tax-settings#change-tax-provider-of-a-region) to a region.\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/services/my-tax.ts\"\nclass MyTaxService extends AbstractTaxService {\n static identifier = \"my-tax\"\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---" + } + ] + }, + "children": [ + { + "id": 3712, + "name": "getTaxLines", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3713, + "name": "getTaxLines", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used when retrieving the tax lines for line items and shipping methods.\nThis occurs during checkout or when calculating totals for orders, swaps, or returns." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The list of calculated line item and shipping method tax lines.\nIf an item in the array has the " + }, + { + "kind": "code", + "text": "`shipping_method_id`" + }, + { + "kind": "text", + "text": " property, then it's a shipping method tax line. Otherwise, if it has\nthe " + }, + { + "kind": "code", + "text": "`item_id`" + }, + { + "kind": "text", + "text": " property, then it's a line item tax line." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "An example of how this method is implemented in the " + }, + { + "kind": "code", + "text": "`system`" + }, + { + "kind": "text", + "text": " provider implemented in the Medusa backend:\n\n" + }, + { + "kind": "code", + "text": "```ts\n// ...\n\nclass SystemTaxService extends AbstractTaxService {\n // ...\n\n async getTaxLines(\n itemLines: ItemTaxCalculationLine[],\n shippingLines: ShippingTaxCalculationLine[],\n context: TaxCalculationContext\n ): Promise {\n let taxLines: ProviderTaxLine[] = itemLines.flatMap((l) => {\n return l.rates.map((r) => ({\n rate: r.rate || 0,\n name: r.name,\n code: r.code,\n item_id: l.item.id,\n }))\n })\n\n taxLines = taxLines.concat(\n shippingLines.flatMap((l) => {\n return l.rates.map((r) => ({\n rate: r.rate || 0,\n name: r.name,\n code: r.code,\n shipping_method_id: l.shipping_method.id,\n }))\n })\n )\n\n return taxLines\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3714, + "name": "itemLines", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item lines to calculate taxes for." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 3699, + "name": "ItemTaxCalculationLine", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3715, + "name": "shippingLines", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method lines to calculate taxes for." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 3695, + "name": "ShippingTaxCalculationLine", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3716, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Context relevant and useful for the taxes calculation." + } + ] + }, + "type": { + "type": "reference", + "target": 3703, + "name": "TaxCalculationContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 4913, + "name": "ProviderTaxLine", + "package": "@medusajs/medusa" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 3712 + ] + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 3717, + "name": "AbstractTaxService" + } + ] + }, + { + "id": 3717, + "name": "AbstractTaxService", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 3719, + "name": "identifier", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3723, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3724, + "name": "new AbstractTaxService", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your tax provider to access the different services in Medusa through dependency injection.\n\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the service.\nAdditionally, if you’re creating your tax provider as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, you can access it in the constructor." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport { LineItemService } from \"@medusajs/medusa\"\n\ntype InjectedDependencies = {\n lineItemService: LineItemService\n}\n\nclass MyTaxService extends AbstractTaxService {\n protected readonly lineItemService_: LineItemService\n\n constructor({ lineItemService }: InjectedDependencies) {\n super(arguments[0])\n this.lineItemService_ = lineItemService\n\n // you can also initialize a client that\n // communicates with a third-party service.\n this.client = new Client(options)\n }\n\n // ...\n}\n\nexport default MyTaxService\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3725, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 3726, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this tax provider is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 3717, + "name": "AbstractTaxService", + "package": "@medusajs/medusa" + }, + "overwrites": { + "type": "reference", + "target": 3769, + "name": "TransactionBaseService.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": 3768, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 3727, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 3728, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this tax provider is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3731, + "name": "getTaxLines", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 3732, + "name": "getTaxLines", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used when retrieving the tax lines for line items and shipping methods.\nThis occurs during checkout or when calculating totals for orders, swaps, or returns." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The list of calculated line item and shipping method tax lines.\nIf an item in the array has the " + }, + { + "kind": "code", + "text": "`shipping_method_id`" + }, + { + "kind": "text", + "text": " property, then it's a shipping method tax line. Otherwise, if it has\nthe " + }, + { + "kind": "code", + "text": "`item_id`" + }, + { + "kind": "text", + "text": " property, then it's a line item tax line." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "An example of how this method is implemented in the " + }, + { + "kind": "code", + "text": "`system`" + }, + { + "kind": "text", + "text": " provider implemented in the Medusa backend:\n\n" + }, + { + "kind": "code", + "text": "```ts\n// ...\n\nclass SystemTaxService extends AbstractTaxService {\n // ...\n\n async getTaxLines(\n itemLines: ItemTaxCalculationLine[],\n shippingLines: ShippingTaxCalculationLine[],\n context: TaxCalculationContext\n ): Promise {\n let taxLines: ProviderTaxLine[] = itemLines.flatMap((l) => {\n return l.rates.map((r) => ({\n rate: r.rate || 0,\n name: r.name,\n code: r.code,\n item_id: l.item.id,\n }))\n })\n\n taxLines = taxLines.concat(\n shippingLines.flatMap((l) => {\n return l.rates.map((r) => ({\n rate: r.rate || 0,\n name: r.name,\n code: r.code,\n shipping_method_id: l.shipping_method.id,\n }))\n })\n )\n\n return taxLines\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 3733, + "name": "itemLines", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item lines to calculate taxes for." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 3699, + "name": "ItemTaxCalculationLine", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3734, + "name": "shippingLines", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method lines to calculate taxes for." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 3695, + "name": "ShippingTaxCalculationLine", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3735, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Context relevant and useful for the taxes calculation." + } + ] + }, + "type": { + "type": "reference", + "target": 3703, + "name": "TaxCalculationContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 4913, + "name": "ProviderTaxLine", + "package": "@medusajs/medusa" + } + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3713, + "name": "ITaxService.getTaxLines" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 3712, + "name": "ITaxService.getTaxLines" + } + }, + { + "id": 3736, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": 3773, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 3737, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 3774, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 3738, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 3739, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 3775, + "name": "TransactionBaseService.activeManager_" + } + }, + { + "id": 3740, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": 3777, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 3741, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3778, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 3742, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3779, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 3743, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3744, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3745, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": 3781, + "name": "TransactionBaseService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3780, + "name": "TransactionBaseService.withTransaction" + } + }, + { + "id": 3746, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3747, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3748, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 3749, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3750, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3750 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 3784, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3783, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + }, + { + "id": 3751, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3752, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 3753, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3754, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 3755, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3756, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3757, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3758, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 3759, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 3760, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3761, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3762, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 3763, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3764, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3765, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3766, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 3789, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3788, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3723 + ] + }, + { + "title": "Properties", + "children": [ + 3719, + 3727, + 3728, + 3736, + 3737, + 3740, + 3741, + 3742 + ] + }, + { + "title": "Accessors", + "children": [ + 3738 + ] + }, + { + "title": "Methods", + "children": [ + 3731, + 3743, + 3746, + 3751 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 3711, + "name": "ITaxService", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 3767, + "name": "TransactionBaseService", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 3773, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + }, + { + "id": 3774, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + } + }, + { + "id": 3775, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 3776, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + }, + { + "id": 3768, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3769, + "name": "new TransactionBaseService", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 3770, + "name": "__container__", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 3771, + "name": "__configModule__", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3772, + "name": "__moduleDeclaration__", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 3767, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 3777, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 3778, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3779, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3780, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3781, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3782, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + } + } + ] + }, + { + "id": 3783, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3784, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3785, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 3786, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3787, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3787 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 3788, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 3789, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 3790, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3791, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 3792, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3793, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3794, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3795, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 3796, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 3797, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3798, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3799, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 3800, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3801, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3802, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3803, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2735, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2734, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3768 + ] + }, + { + "title": "Properties", + "children": [ + 3773, + 3774, + 3777, + 3778, + 3779 + ] + }, + { + "title": "Accessors", + "children": [ + 3775 + ] + }, + { + "title": "Methods", + "children": [ + 3780, + 3783, + 3788 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 2704, + "name": "IBatchJobStrategy" + }, + { + "type": "reference", + "target": 2748, + "name": "AbstractBatchJobStrategy" + }, + { + "type": "reference", + "target": 2824, + "name": "AbstractCartCompletionStrategy" + }, + { + "type": "reference", + "target": 2870, + "name": "IFileService" + }, + { + "type": "reference", + "target": 2920, + "name": "AbstractFileService" + }, + { + "type": "reference", + "target": 2980, + "name": "FulfillmentService" + }, + { + "type": "reference", + "target": 3057, + "name": "AbstractFulfillmentService" + }, + { + "type": "reference", + "target": 3149, + "name": "INotificationService" + }, + { + "type": "reference", + "target": 3191, + "name": "AbstractNotificationService" + }, + { + "type": "reference", + "target": 3380, + "name": "PaymentService" + }, + { + "type": "reference", + "target": 3462, + "name": "AbstractPaymentService" + }, + { + "type": "reference", + "target": 3567, + "name": "AbstractPriceSelectionStrategy" + }, + { + "type": "reference", + "target": 3648, + "name": "AbstractTaxCalculationStrategy" + }, + { + "type": "reference", + "target": 3717, + "name": "AbstractTaxService" + } + ] + }, + { + "id": 3804, "name": "joinerConfig", "variant": "declaration", "kind": 32, @@ -115039,7 +97374,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 4925, + "target": 4914, "name": "ModuleJoinerConfig", "package": "@medusajs/types" } @@ -115047,205 +97382,2245 @@ "defaultValue": "..." }, { - "id": 4236, - "name": "DbAwareColumn", + "id": 5220, + "name": "HTTP_METHODS", "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4237, - "name": "DbAwareColumn", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4238, - "name": "columnOptions", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/decorator/options/ColumnOptions.d.ts", - "qualifiedName": "ColumnOptions" - }, - "name": "ColumnOptions", - "package": "typeorm" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.decorators.legacy.d.ts", - "qualifiedName": "PropertyDecorator" - }, - "name": "PropertyDecorator", - "package": "typescript" + "kind": 32, + "flags": { + "isConst": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "List of all the supported HTTP methods" } + ] + }, + "type": { + "type": "typeOperator", + "operator": "readonly", + "target": { + "type": "tuple", + "elements": [ + { + "type": "literal", + "value": "GET" + }, + { + "type": "literal", + "value": "POST" + }, + { + "type": "literal", + "value": "PUT" + }, + { + "type": "literal", + "value": "PATCH" + }, + { + "type": "literal", + "value": "DELETE" + }, + { + "type": "literal", + "value": "OPTIONS" + }, + { + "type": "literal", + "value": "HEAD" + } + ] } - ] + }, + "defaultValue": "..." }, { - "id": 4320, - "name": "IsType", + "id": 5129, + "name": "RouteVerb", "variant": "declaration", - "kind": 64, + "kind": 2097152, "flags": {}, - "signatures": [ - { - "id": 4321, - "name": "IsType", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4322, - "name": "types", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - }, - { - "id": 4323, - "name": "validationOptions", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/class-validator/types/decorator/ValidationOptions.d.ts", - "qualifiedName": "ValidationOptions" - }, - "name": "ValidationOptions", - "package": "class-validator" - } - } - ], - "type": { + "type": { + "type": "indexedAccess", + "indexType": { + "type": "intrinsic", + "name": "number" + }, + "objectType": { + "type": "query", + "queryType": { + "type": "reference", + "target": 5220, + "name": "HTTP_METHODS", + "package": "@medusajs/medusa" + } + } + } + }, + { + "id": 4951, + "name": "MiddlewareVerb", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "USE" + }, + { + "type": "literal", + "value": "ALL" + }, + { + "type": "reference", + "target": 5129, + "name": "RouteVerb", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 4054, + "name": "MiddlewareFunction", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 4162, + "name": "MedusaRequestHandler", + "package": "@medusajs/medusa" + }, + { "type": "reflection", "declaration": { - "id": 4324, + "id": 4055, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 4325, + "id": 4056, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4326, - "name": "object", + "id": 4057, + "name": "args", "variant": "param", "kind": 32768, - "flags": {}, + "flags": { + "isRest": true + }, "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Object" - }, - "name": "Object", - "package": "typescript" - } - }, - { - "id": 4327, - "name": "propertyName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } } } ], "type": { "type": "intrinsic", - "name": "void" + "name": "any" } } ] } } + ] + } + }, + { + "id": 4955, + "name": "MedusaErrorHandlerFunction", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4956, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4957, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4958, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4959, + "name": "req", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4149, + "name": "MedusaRequest", + "package": "@medusajs/medusa" + } + }, + { + "id": 4960, + "name": "res", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4160, + "name": "MedusaResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 4961, + "name": "next", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4161, + "name": "MedusaNextFunction", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + } + ] + } + } + ] + } + } + }, + { + "id": 4952, + "name": "ParserConfig", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": false + }, + { + "type": "reflection", + "declaration": { + "id": 4953, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4954, + "name": "sizeLimit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4954 + ] + } + ] + } + } + ] + } + }, + { + "id": 4058, + "name": "MiddlewareRoute", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4059, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4060, + "name": "method", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 4951, + "name": "MiddlewareVerb", + "package": "@medusajs/medusa" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": 4951, + "name": "MiddlewareVerb", + "package": "@medusajs/medusa" + } + } + ] + } + }, + { + "id": 4061, + "name": "matcher", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "RegExp" + }, + "name": "RegExp", + "package": "typescript" + } + ] + } + }, + { + "id": 4062, + "name": "bodyParser", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 4952, + "name": "ParserConfig", + "package": "@medusajs/medusa" + } + }, + { + "id": 4063, + "name": "middlewares", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4054, + "name": "MiddlewareFunction", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4060, + 4061, + 4062, + 4063 + ] + } + ] + } + } + }, + { + "id": 4064, + "name": "MiddlewaresConfig", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4065, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4066, + "name": "errorHandler", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": false + }, + { + "type": "reference", + "target": 4955, + "name": "MedusaErrorHandlerFunction", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 4067, + "name": "routes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4058, + "name": "MiddlewareRoute", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4066, + 4067 + ] + } + ] + } + } + }, + { + "id": 3805, + "name": "BatchJobStatus", + "variant": "declaration", + "kind": 8, + "flags": {}, + "children": [ + { + "id": 3806, + "name": "CREATED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "created" + } + }, + { + "id": 3807, + "name": "PRE_PROCESSED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "pre_processed" + } + }, + { + "id": 3808, + "name": "CONFIRMED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "confirmed" + } + }, + { + "id": 3809, + "name": "PROCESSING", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "processing" + } + }, + { + "id": 3810, + "name": "COMPLETED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "completed" + } + }, + { + "id": 3811, + "name": "CANCELED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "canceled" + } + }, + { + "id": 3812, + "name": "FAILED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "failed" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 3806, + 3807, + 3808, + 3809, + 3810, + 3811, + 3812 + ] } ] }, { - "id": 4204, - "name": "addOrderToSelect", + "id": 3813, + "name": "BatchJobUpdateProps", "variant": "declaration", - "kind": 64, + "kind": 2097152, "flags": {}, - "signatures": [ - { - "id": 4205, - "name": "addOrderToSelect", - "variant": "signature", - "kind": 4096, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Pick" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/batch-job.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "context" + }, + { + "type": "literal", + "value": "result" + } + ] + } + ], + "name": "Pick", + "package": "typescript" + } + ], + "name": "Partial", + "package": "typescript" + } + }, + { + "id": 3814, + "name": "CreateBatchJobInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 3815, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "typeParameter": [ + "children": [ { - "id": 4206, - "name": "TEntity", - "variant": "typeParam", - "kind": 131072, - "flags": {} + "id": 3816, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3817, + "name": "context", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": "context" + }, + "objectType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/batch-job.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3818, + "name": "dry_run", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], - "parameters": [ + "groups": [ { - "id": 4207, - "name": "order", - "variant": "param", - "kind": 32768, + "title": "Properties", + "children": [ + 3816, + 3817, + 3818 + ] + } + ] + } + } + }, + { + "id": 3819, + "name": "BatchJobResultError", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 3820, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3821, + "name": "message", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3822, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3821, + 3822 + ] + } + ], + "indexSignature": { + "id": 3823, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "parameters": [ + { + "id": 3824, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + } + } + }, + { + "id": 3825, + "name": "BatchJobResultStatDescriptor", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 3826, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3827, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3828, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3829, + "name": "message", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3827, + 3828, + 3829 + ] + } + ] + } + } + }, + { + "id": 3830, + "name": "FilterableBatchJobProps", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 3831, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 3832, + "name": "new FilterableBatchJobProps", + "variant": "signature", + "kind": 16384, "flags": {}, "type": { + "type": "reference", + "target": 3830, + "name": "FilterableBatchJobProps", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 3833, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 3834, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 3805, + "name": "BatchJobStatus", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3835, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 3836, + "name": "created_by", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 3837, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 3838, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3831 + ] + }, + { + "title": "Properties", + "children": [ + 3833, + 3834, + 3835, + 3836, + 3837, + 3838 + ] + } + ] + }, + { + "id": 3839, + "name": "BatchJobCreateProps", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Pick" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/batch-job.ts", + "qualifiedName": "BatchJob" + }, + "name": "BatchJob", + "package": "@medusajs/medusa" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "context" + }, + { + "type": "literal", + "value": "type" + }, + { + "type": "literal", + "value": "created_by" + }, + { + "type": "literal", + "value": "dry_run" + } + ] + } + ], + "name": "Pick", + "package": "typescript" + } + }, + { + "id": 3846, + "name": "WithRequiredProperty", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Utility type used to remove some optional attributes (coming from K) from a type T" + } + ] + }, + "typeParameters": [ + { + "id": 3847, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3848, + "name": "K", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 3847, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3847, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + { + "type": "mapped", + "parameter": "Property", + "parameterType": { + "type": "reference", + "target": 3848, + "name": "K", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "templateType": { + "type": "indexedAccess", + "indexType": { "type": "reference", "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsOrder.d.ts", - "qualifiedName": "FindOptionsOrder" + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "Property" + }, + "name": "Property", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 3847, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + }, + "optionalModifier": "-" + } + ] + } + }, + { + "id": 3849, + "name": "PartialPick", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 3850, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3851, + "name": "K", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 3850, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + } + ], + "type": { + "type": "mapped", + "parameter": "P", + "parameterType": { + "type": "reference", + "target": 3851, + "name": "K", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "templateType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "P" + }, + "name": "P", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 3850, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + }, + "optionalModifier": "+" + } + }, + { + "id": 3852, + "name": "Writable", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 3853, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "mapped", + "parameter": "key", + "parameterType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 3853, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + }, + "templateType": { + "type": "union", + "types": [ + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "key" + }, + "name": "key", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 3853, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "key" + }, + "name": "key", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 3853, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "name": "FindOperator", + "package": "typeorm" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "key" + }, + "name": "key", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 3853, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + } + ], + "name": "FindOperator", + "package": "typeorm" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + }, + "readonlyModifier": "-" + } + }, + { + "id": 3854, + "name": "FindConfig", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 3855, + "name": "select", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 3863, + "name": "Entity", + "package": "@medusajs/medusa", + "qualifiedName": "FindConfig.Entity", + "refersToTypeParameter": true + } + } + } + }, + { + "id": 3856, + "name": "skip", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3857, + "name": "take", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3858, + "name": "relations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 3859, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 3860, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "indexSignature": { + "id": 3861, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "parameters": [ + { + "id": 3862, + "name": "K", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "ASC" + }, + { + "type": "literal", + "value": "DESC" + } + ] + } + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3855, + 3856, + 3857, + 3858, + 3859 + ] + } + ], + "typeParameters": [ + { + "id": 3863, + "name": "Entity", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ] + }, + { + "id": 3864, + "name": "ExtendedFindConfig", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 3872, + "name": "TEntity", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" }, "typeArguments": [ { "type": "reference", - "target": 4206, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOneOptions.d.ts", + "qualifiedName": "FindOneOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3872, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "FindOneOptions", + "package": "typeorm" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "where" + }, + { + "type": "literal", + "value": "relations" + }, + { + "type": "literal", + "value": "select" + } + ] } ], - "name": "FindOptionsOrder", - "package": "typeorm" + "name": "Omit", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindManyOptions.d.ts", + "qualifiedName": "FindManyOptions" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3872, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "FindManyOptions", + "package": "typeorm" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "where" + }, + { + "type": "literal", + "value": "relations" + }, + { + "type": "literal", + "value": "select" + } + ] + } + ], + "name": "Omit", + "package": "typescript" + } + ] + }, + { + "type": "reflection", + "declaration": { + "id": 3865, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3866, + "name": "select", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsSelect.d.ts", + "qualifiedName": "FindOptionsSelect" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3872, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "FindOptionsSelect", + "package": "typeorm" + } + }, + { + "id": 3867, + "name": "relations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsRelations.d.ts", + "qualifiedName": "FindOptionsRelations" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3872, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "FindOptionsRelations", + "package": "typeorm" + } + }, + { + "id": 3868, + "name": "where", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3872, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3872, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + } + } + ] + } + }, + { + "id": 3869, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsOrder.d.ts", + "qualifiedName": "FindOptionsOrder" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3872, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "FindOptionsOrder", + "package": "typeorm" + } + }, + { + "id": 3870, + "name": "skip", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3871, + "name": "take", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3866, + 3867, + 3868, + 3869, + 3870, + 3871 + ] + } + ] + } + } + ] + } + }, + { + "id": 3873, + "name": "QuerySelector", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 3876, + "name": "TEntity", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3881, + "typeArguments": [ + { + "type": "reference", + "target": 3876, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Selector", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 3874, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3875, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3875 + ] + } + ] + } + } + ] + } + }, + { + "id": 3877, + "name": "TreeQuerySelector", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 3880, + "name": "TEntity", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3873, + "typeArguments": [ + { + "type": "reference", + "target": 3880, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "QuerySelector", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 3878, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3879, + "name": "include_descendants_tree", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3879 + ] + } + ] + } + } + ] + } + }, + { + "id": 4941, + "name": "InnerSelector", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 4942, + "name": "TEntity", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "mapped", + "parameter": "key", + "parameterType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 4942, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + }, + "templateType": { + "type": "union", + "types": [ + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "key" + }, + "name": "key", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 4942, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true } }, { - "id": 4208, - "name": "select", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "key" + }, + "name": "key", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 4942, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + }, + { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3935, + "name": "NumericalComparisonOperator", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "key" + }, + "name": "key", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 4942, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + ], + "name": "FindOperator", + "package": "typeorm" + } + ] + }, + "optionalModifier": "+" + } + }, + { + "id": 3881, + "name": "Selector", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 3882, + "name": "TEntity", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 4941, + "typeArguments": [ + { + "type": "reference", + "target": 3882, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "InnerSelector", + "package": "@medusajs/medusa" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": 4941, + "typeArguments": [ + { + "type": "reference", + "target": 3882, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "InnerSelector", + "package": "@medusajs/medusa" + } + } + ] + } + }, + { + "id": 3883, + "name": "TotalField", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "shipping_total" + }, + { + "type": "literal", + "value": "discount_total" + }, + { + "type": "literal", + "value": "tax_total" + }, + { + "type": "literal", + "value": "refunded_total" + }, + { + "type": "literal", + "value": "total" + }, + { + "type": "literal", + "value": "subtotal" + }, + { + "type": "literal", + "value": "refundable_amount" + }, + { + "type": "literal", + "value": "gift_card_total" + }, + { + "type": "literal", + "value": "gift_card_tax_total" + } + ] + } + }, + { + "id": 3884, + "name": "CustomFindOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 3885, + "name": "select", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { "type": "reference", "target": { "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsSelect.d.ts", @@ -115254,91 +99629,2486 @@ "typeArguments": [ { "type": "reference", - "target": 4206, - "name": "TEntity", + "target": 3890, + "name": "TModel", "package": "@medusajs/medusa", + "qualifiedName": "CustomFindOptions.TModel", "refersToTypeParameter": true } ], "name": "FindOptionsSelect", "package": "typeorm" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsSelect.d.ts", + "qualifiedName": "FindOptionsSelectByString" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3890, + "name": "TModel", + "package": "@medusajs/medusa", + "qualifiedName": "CustomFindOptions.TModel", + "refersToTypeParameter": true + } + ], + "name": "FindOptionsSelectByString", + "package": "typeorm" } - } - ], + ] + } + }, + { + "id": 3886, + "name": "where", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3890, + "name": "TModel", + "package": "@medusajs/medusa", + "qualifiedName": "CustomFindOptions.TModel", + "refersToTypeParameter": true + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + }, + { + "type": "mapped", + "parameter": "P", + "parameterType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "intrinsic", + "name": "symbol" + } + ] + }, + "templateType": { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "P" + }, + "name": "P", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 3890, + "name": "TModel", + "package": "@medusajs/medusa", + "qualifiedName": "CustomFindOptions.TModel", + "refersToTypeParameter": true + } + } + }, + "optionalModifier": "+" + } + ] + }, + { + "type": "intersection", + "types": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "typeArguments": [ + { + "type": "reference", + "target": 3890, + "name": "TModel", + "package": "@medusajs/medusa", + "qualifiedName": "CustomFindOptions.TModel", + "refersToTypeParameter": true + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + } + }, + { + "type": "mapped", + "parameter": "P", + "parameterType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "intrinsic", + "name": "symbol" + } + ] + }, + "templateType": { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "P" + }, + "name": "P", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 3890, + "name": "TModel", + "package": "@medusajs/medusa", + "qualifiedName": "CustomFindOptions.TModel", + "refersToTypeParameter": true + } + } + }, + "optionalModifier": "+" + } + ] + } + ] + } + }, + { + "id": 3887, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/OrderByCondition.d.ts", + "qualifiedName": "OrderByCondition" + }, + "name": "OrderByCondition", + "package": "typeorm" + } + }, + { + "id": 3888, + "name": "skip", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, "type": { "type": "intrinsic", - "name": "void" + "name": "number" + } + }, + { + "id": 3889, + "name": "take", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3885, + 3886, + 3887, + 3888, + 3889 + ] + } + ], + "typeParameters": [ + { + "id": 3890, + "name": "TModel", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 3891, + "name": "InKeys", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 3890, + "name": "TModel", + "package": "@medusajs/medusa", + "qualifiedName": "CustomFindOptions.TModel", + "refersToTypeParameter": true + } } } ] }, { - "id": 758, - "name": "adjustInventoryForCancelledFulfillment", + "id": 3892, + "name": "QueryConfig", "variant": "declaration", - "kind": 64, + "kind": 2097152, "flags": {}, - "signatures": [ + "typeParameters": [ { - "id": 759, - "name": "adjustInventoryForCancelledFulfillment", - "variant": "signature", - "kind": 4096, + "id": 3900, + "name": "TEntity", + "variant": "typeParam", + "kind": 131072, "flags": {}, - "parameters": [ + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", + "qualifiedName": "BaseEntity" + }, + "name": "BaseEntity", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 3893, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ { - "id": 760, - "name": "fulfillment", - "variant": "param", - "kind": 32768, + "id": 3894, + "name": "defaultFields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 3900, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + }, + { + "id": 3895, + "name": "defaultRelations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 3896, + "name": "allowedFields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 3897, + "name": "allowedRelations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 3898, + "name": "defaultLimit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3899, + "name": "isList", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3894, + 3895, + 3896, + 3897, + 3898, + 3899 + ] + } + ] + } + } + }, + { + "id": 3901, + "name": "RequestQueryFields", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Request parameters used to configure and paginate retrieved data." + } + ] + }, + "children": [ + { + "id": 3902, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3903, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3904, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3905, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3906, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with " + }, + { + "kind": "code", + "text": "`-`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3902, + 3903, + 3904, + 3905, + 3906 + ] + } + ] + }, + { + "id": 3907, + "name": "PaginatedResponse", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Pagination fields returned in the response of an API route." + } + ] + }, + "children": [ + { + "id": 3908, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum number of items that can be returned in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3909, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items skipped before the returned items in the list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3910, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of items available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3908, + 3909, + 3910 + ] + } + ] + }, + { + "id": 3911, + "name": "DeleteResponse", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The response returned for a " + }, + { + "kind": "code", + "text": "`DELETE`" + }, + { + "kind": "text", + "text": " request." + } + ] + }, + "children": [ + { + "id": 3912, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the deleted item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3913, + "name": "object", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the deleted item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "product-collection" + }, + { + "id": 3914, + "name": "deleted", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the item was deleted successfully." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": true + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3912, + 3913, + 3914 + ] + } + ] + }, + { + "id": 3915, + "name": "EmptyQueryParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 3916, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 3917, + "name": "new EmptyQueryParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 3915, + "name": "EmptyQueryParams", + "package": "@medusajs/medusa" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3916 + ] + } + ] + }, + { + "id": 3918, + "name": "DateComparisonOperator", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fields used to apply flexible filters on dates." + } + ] + }, + "children": [ + { + "id": 3919, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 3920, + "name": "new DateComparisonOperator", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 3921, + "name": "lt", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered date must be less than this value." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 3922, + "name": "gt", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered date must be greater than this value." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 3923, + "name": "gte", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered date must be greater than or equal to this value." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 3924, + "name": "lte", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered date must be less than or equal to this value." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3919 + ] + }, + { + "title": "Properties", + "children": [ + 3921, + 3922, + 3923, + 3924 + ] + } + ] + }, + { + "id": 3925, + "name": "StringComparisonOperator", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fields used to apply flexible filters on strings." + } + ] + }, + "children": [ + { + "id": 3926, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 3927, + "name": "new StringComparisonOperator", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 3928, + "name": "lt", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered string must be less than this value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3929, + "name": "gt", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered string must be greater than this value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3930, + "name": "gte", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered string must be greater than or equal to this value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3931, + "name": "lte", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered string must be less than or equal to this value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3932, + "name": "contains", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered string must contain this value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3933, + "name": "starts_with", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered string must start with this value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3934, + "name": "ends_with", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered string must end with this value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3926 + ] + }, + { + "title": "Properties", + "children": [ + 3928, + 3929, + 3930, + 3931, + 3932, + 3933, + 3934 + ] + } + ] + }, + { + "id": 3935, + "name": "NumericalComparisonOperator", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fields used to apply flexible filters on numbers." + } + ] + }, + "children": [ + { + "id": 3936, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 3937, + "name": "new NumericalComparisonOperator", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 3935, + "name": "NumericalComparisonOperator", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 3938, + "name": "lt", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered number must be less than this value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3939, + "name": "gt", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered number must be greater than this value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3940, + "name": "gte", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered number must be greater than or equal to this value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3941, + "name": "lte", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The filtered number must be less than or equal to this value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3936 + ] + }, + { + "title": "Properties", + "children": [ + 3938, + 3939, + 3940, + 3941 + ] + } + ] + }, + { + "id": 3942, + "name": "AddressPayload", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Address fields used when creating/updating an address." + } + ] + }, + "children": [ + { + "id": 3943, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 3944, + "name": "new AddressPayload", + "variant": "signature", + "kind": 16384, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns." + "text": "Address fields used when creating/updating an address." } ] }, "type": { "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/fulfillment.ts", - "qualifiedName": "Fulfillment" - }, - "name": "Fulfillment", + "target": 3942, + "name": "AddressPayload", "package": "@medusajs/medusa" } + } + ] + }, + { + "id": 3945, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "First name" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3946, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Last name" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3947, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Phone Number" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3948, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional key-value map with additional details" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 3949, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Company" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3950, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Address line 1" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3951, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Address line 2" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3952, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "City" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3953, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The 2 character ISO code of the country in lower case" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3954, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Province" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3955, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Postal Code" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3943 + ] + }, + { + "title": "Properties", + "children": [ + 3945, + 3946, + 3947, + 3948, + 3949, + 3950, + 3951, + 3952, + 3953, + 3954, + 3955 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 2276, + "name": "StorePostCustomersCustomerAddressesAddressReq" + } + ] + }, + { + "id": 3956, + "name": "AddressCreatePayload", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Address fields used when creating an address." + } + ] + }, + "children": [ + { + "id": 3957, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ { - "id": 761, - "name": "context", + "id": 3958, + "name": "new AddressCreatePayload", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Address fields used when creating an address." + } + ] + }, + "type": { + "type": "reference", + "target": 3956, + "name": "AddressCreatePayload", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 3959, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "First name" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3960, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Last name" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3961, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Phone Number" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3962, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional key-value map with additional details" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 3963, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3964, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Address line 1" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3965, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Address line 2" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3966, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "City" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3967, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The 2 character ISO code of the country in lower case" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3968, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Province" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3969, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Postal Code" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3957 + ] + }, + { + "title": "Properties", + "children": [ + 3959, + 3960, + 3961, + 3962, + 3963, + 3964, + 3965, + 3966, + 3967, + 3968, + 3969 + ] + } + ] + }, + { + "id": 3970, + "name": "FindParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how data is retrieved." + } + ] + }, + "children": [ + { + "id": 3971, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 3972, + "name": "new FindParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 3973, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3974, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3971 + ] + }, + { + "title": "Properties", + "children": [ + 3973, + 3974 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 154, + "name": "AdminGetCustomerGroupsGroupParams" + }, + { + "type": "reference", + "target": 238, + "name": "AdminPostDiscountsDiscountConditionsParams" + }, + { + "type": "reference", + "target": 273, + "name": "AdminPostDiscountsParams" + }, + { + "type": "reference", + "target": 284, + "name": "AdminDeleteDiscountsDiscountConditionsConditionParams" + }, + { + "type": "reference", + "target": 289, + "name": "AdminGetDiscountsDiscountConditionsConditionParams" + }, + { + "type": "reference", + "target": 294, + "name": "AdminGetDiscountParams" + }, + { + "type": "reference", + "target": 299, + "name": "AdminGetDiscountsDiscountCodeParams" + }, + { + "type": "reference", + "target": 324, + "name": "AdminPostDiscountsDiscountConditionsConditionParams" + }, + { + "type": "reference", + "target": 359, + "name": "AdminPostDiscountsDiscountParams" + }, + { + "type": "reference", + "target": 370, + "name": "AdminPostDiscountsDiscountConditionsConditionBatchParams" + }, + { + "type": "reference", + "target": 375, + "name": "AdminDeleteDiscountsDiscountConditionsConditionBatchParams" + }, + { + "type": "reference", + "target": 526, + "name": "AdminPostInventoryItemsParams" + }, + { + "type": "reference", + "target": 537, + "name": "AdminPostInventoryItemsItemLocationLevelsParams" + }, + { + "type": "reference", + "target": 542, + "name": "AdminGetInventoryItemsItemParams" + }, + { + "type": "reference", + "target": 568, + "name": "AdminGetInventoryItemsItemLocationLevelsParams" + }, + { + "type": "reference", + "target": 590, + "name": "AdminPostInventoryItemsInventoryItemParams" + }, + { + "type": "reference", + "target": 600, + "name": "AdminPostInventoryItemsItemLocationLevelsLevelParams" + }, + { + "type": "reference", + "target": 699, + "name": "GetOrderEditsOrderEditParams" + }, + { + "type": "reference", + "target": 743, + "name": "AdminPostOrdersOrderShippingMethodsParams" + }, + { + "type": "reference", + "target": 748, + "name": "AdminPostOrdersOrderArchiveParams" + }, + { + "type": "reference", + "target": 753, + "name": "AdminPostOrdersClaimCancel" + }, + { + "type": "reference", + "target": 764, + "name": "AdminPostOrdersOrderFulfillementsCancelParams" + }, + { + "type": "reference", + "target": 769, + "name": "AdminPostOrdersClaimFulfillmentsCancelParams" + }, + { + "type": "reference", + "target": 774, + "name": "AdminPostOrdersOrderSwapFulfillementsCancelParams" + }, + { + "type": "reference", + "target": 779, + "name": "AdminPostOrdersOrderCancel" + }, + { + "type": "reference", + "target": 784, + "name": "AdminPostOrdersSwapCancelParams" + }, + { + "type": "reference", + "target": 789, + "name": "AdminPostOrdersOrderCaptureParams" + }, + { + "type": "reference", + "target": 794, + "name": "AdminPostOrdersOrderCompleteParams" + }, + { + "type": "reference", + "target": 812, + "name": "AdminPostOrdersOrderClaimsParams" + }, + { + "type": "reference", + "target": 822, + "name": "AdminPostOrdersOrderClaimsClaimShipmentsParams" + }, + { + "type": "reference", + "target": 841, + "name": "AdminPostOrdersOrderFulfillmentsParams" + }, + { + "type": "reference", + "target": 852, + "name": "AdminPostOrdersOrderShipmentParams" + }, + { + "type": "reference", + "target": 868, + "name": "AdminPostOrdersOrderSwapsParams" + }, + { + "type": "reference", + "target": 879, + "name": "AdminPostOrdersOrderSwapsSwapShipmentsParams" + }, + { + "type": "reference", + "target": 890, + "name": "AdminPostOrdersOrderClaimsClaimFulfillmentsParams" + }, + { + "type": "reference", + "target": 901, + "name": "AdminPostOrdersOrderSwapsSwapFulfillmentsParams" + }, + { + "type": "reference", + "target": 906, + "name": "AdminGetOrdersOrderParams" + }, + { + "type": "reference", + "target": 934, + "name": "AdminPostOrdersOrderSwapsSwapProcessPaymentParams" + }, + { + "type": "reference", + "target": 946, + "name": "AdminPostOrdersOrderRefundsParams" + }, + { + "type": "reference", + "target": 961, + "name": "AdminPostOrdersOrderReturnsParams" + }, + { + "type": "reference", + "target": 973, + "name": "AdminPostOrdersOrderClaimsClaimParams" + }, + { + "type": "reference", + "target": 991, + "name": "AdminPostOrdersOrderParams" + }, + { + "type": "reference", + "target": 1006, + "name": "AdminGetPaymentCollectionsParams" + }, + { + "type": "reference", + "target": 1023, + "name": "GetPaymentsParams" + }, + { + "type": "reference", + "target": 1168, + "name": "AdminGetProductCategoryParams" + }, + { + "type": "reference", + "target": 1197, + "name": "AdminPostProductCategoriesParams" + }, + { + "type": "reference", + "target": 1213, + "name": "AdminPostProductCategoriesCategoryParams" + }, + { + "type": "reference", + "target": 1222, + "name": "AdminPostProductCategoriesCategoryProductsBatchParams" + }, + { + "type": "reference", + "target": 1231, + "name": "AdminDeleteProductCategoriesCategoryProductsBatchParams" + }, + { + "type": "reference", + "target": 1402, + "name": "AdminGetProductParams" + }, + { + "type": "reference", + "target": 1826, + "name": "AdminPostStockLocationsParams" + }, + { + "type": "reference", + "target": 1831, + "name": "AdminGetStockLocationsLocationParams" + }, + { + "type": "reference", + "target": 1855, + "name": "AdminPostStockLocationsLocationParams" + }, + { + "type": "reference", + "target": 2089, + "name": "AdminGetVariantParams" + }, + { + "type": "reference", + "target": 2329, + "name": "StoreGetOrdersParams" + }, + { + "type": "reference", + "target": 2352, + "name": "StoreGetPaymentCollectionsParams" + }, + { + "type": "reference", + "target": 2384, + "name": "StoreGetProductCategoriesCategoryParams" + }, + { + "type": "reference", + "target": 2534, + "name": "StoreGetRegionsRegionParams" + }, + { + "type": "reference", + "target": 4787, + "name": "PriceSelectionParams" + } + ] + }, + { + "id": 3975, + "name": "FindPaginationParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Parameters that can be used to configure how a list of data is paginated." + } + ] + }, + "children": [ + { + "id": 3976, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 3977, + "name": "new FindPaginationParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 3975, + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 3978, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of items to skip when retrieving a list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n0\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "0" + }, + { + "id": 3979, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Limit the number of items returned in the list." + } + ], + "blockTags": [ + { + "tag": "@defaultValue", + "content": [ + { + "kind": "code", + "text": "```ts\n20\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "defaultValue": "20" + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 3976 + ] + }, + { + "title": "Properties", + "children": [ + 3978, + 3979 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 121, + "name": "AdminGetCurrenciesParams" + }, + { + "type": "reference", + "target": 1263, + "name": "AdminGetProductTypesParams" + }, + { + "type": "reference", + "target": 2407, + "name": "StoreGetProductTagsParams" + }, + { + "type": "reference", + "target": 2425, + "name": "StoreGetProductTypesParams" + } + ] + }, + { + "id": 3840, + "name": "extendedFindParamsMixin", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 3841, + "name": "extendedFindParamsMixin", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3842, + "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 762, + "id": 3843, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 763, - "name": "productVariantInventoryService", + "id": 3844, + "name": "limit", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", - "qualifiedName": "ProductVariantInventoryService" - }, - "name": "ProductVariantInventoryService", - "package": "@medusajs/medusa" + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 3845, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" } } ], @@ -115346,80 +102116,7128 @@ { "title": "Properties", "children": [ - 763 + 3844, + 3845 ] } ] } + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "target": 3984, + "typeArguments": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 3975, + "name": "FindPaginationParams", + "package": "@medusajs/medusa" + } + ] + } + ], + "name": "ClassConstructor", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4339, + "name": "FilterableCustomerGroupProps", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on the retrieved customer groups." + } + ] + }, + "children": [ + { + "id": 4340, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4341, + "name": "new FilterableCustomerGroupProps", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4339, + "name": "FilterableCustomerGroupProps", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4342, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter customer groups by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 3925, + "name": "StringComparisonOperator", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 4343, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search customer groups by their name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4344, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Names to filter customer groups by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4345, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the customer groups' " + }, + { + "kind": "code", + "text": "`update_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 4346, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the customer groups' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 4347, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter customer groups by their associated discount condition's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4340 + ] + }, + { + "title": "Properties", + "children": [ + 4342, + 4343, + 4344, + 4345, + 4346, + 4347 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 159, + "name": "AdminGetCustomerGroupsParams" + } + ] + }, + { + "id": 4335, + "name": "CustomerGroupsBatchCustomer", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4336, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4337, + "name": "new CustomerGroupsBatchCustomer", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4335, + "name": "CustomerGroupsBatchCustomer", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4338, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID of the customer" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4336 + ] + }, + { + "title": "Properties", + "children": [ + 4338 + ] + } + ] + }, + { + "id": 4348, + "name": "AdminListCustomerSelector", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters used to filter retrieved customers." + } + ] + }, + "children": [ + { + "id": 4349, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4350, + "name": "new AdminListCustomerSelector", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4348, + "name": "AdminListCustomerSelector", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4351, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term used to search customers' email, first name, last name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4352, + "name": "has_account", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter customers by whether they have an account." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4353, + "name": "groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter customers by the customer's customer groups." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4349 + ] + }, + { + "title": "Properties", + "children": [ + 4351, + 4352, + 4353 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 193, + "name": "AdminGetCustomersParams" + } + ] + }, + { + "id": 4366, + "name": "AdminGetDiscountsDiscountRuleParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on discounts' rules." + } + ] + }, + "children": [ + { + "id": 4367, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4368, + "name": "new AdminGetDiscountsDiscountRuleParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4366, + "name": "AdminGetDiscountsDiscountRuleParams", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4369, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Type to filter discount rules by." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/discount-rule.ts", + "qualifiedName": "DiscountRuleType" + }, + "name": "DiscountRuleType", + "package": "@medusajs/medusa" + } + }, + { + "id": 4370, + "name": "allocation", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Allocation to filter discount rules by." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/discount-rule.ts", + "qualifiedName": "AllocationType" + }, + "name": "AllocationType", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4367 + ] + }, + { + "title": "Properties", + "children": [ + 4369, + 4370 + ] + } + ] + }, + { + "id": 4358, + "name": "AdminUpsertConditionsReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fields to create or update a discount condition." + } + ] + }, + "children": [ + { + "id": 4359, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4360, + "name": "new AdminUpsertConditionsReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4358, + "name": "AdminUpsertConditionsReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4361, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The products associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4362, + "name": "product_collections", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collections associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_collections`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4363, + "name": "product_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product types associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_types`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4364, + "name": "product_tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product tags associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`product_tags`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4365, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer groups associated with the discount condition, if the discount condition's type is " + }, + { + "kind": "code", + "text": "`customer_groups`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4359 + ] + }, + { + "title": "Properties", + "children": [ + 4361, + 4362, + 4363, + 4364, + 4365 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 229, + "name": "AdminPostDiscountsDiscountConditions" + }, + { + "type": "reference", + "target": 264, + "name": "AdminCreateCondition" + }, + { + "type": "reference", + "target": 316, + "name": "AdminPostDiscountsDiscountConditionsCondition" + }, + { + "type": "reference", + "target": 349, + "name": "AdminUpsertCondition" + } + ] + }, + { + "id": 5029, + "name": "FeatureFlagsResponse", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 5030, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5031, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5032, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "boolean" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5031, + 5032 + ] + } + ] + } + } + } + }, + { + "id": 4882, + "name": "CreateReturnType", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/return.ts", + "qualifiedName": "Return" + }, + "name": "Return", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": "beforeInsert" + } + ], + "name": "Omit", + "package": "typescript" + } + }, + { + "id": 3980, + "name": "ExtendedRequest", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 3983, + "name": "TEntity", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Request" + }, + "name": "Request", + "package": "@types/express", + "qualifiedName": "e.Request" + }, + { + "type": "reflection", + "declaration": { + "id": 3981, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3982, + "name": "resource", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 3983, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3982 + ] + } + ] + } + } + ] + } + }, + { + "id": 3984, + "name": "ClassConstructor", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 3988, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 3985, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3986, + "name": "new ClassConstructor", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 3987, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + } + ], + "type": { + "type": "reference", + "target": 3988, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ] + } + } + }, + { + "id": 3989, + "name": "MedusaContainer", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": 4883, + "name": "coreMedusaContainer", + "package": "medusa-core-utils", + "qualifiedName": "MedusaContainer" + } + }, + { + "id": 3990, + "name": "Logger", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 3991, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3992, + "name": "panic", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 3993, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3994, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3995, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 3996, + "name": "shouldLog", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 3997, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 3998, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 3999, + "name": "level", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 4000, + "name": "setLogLevel", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4001, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4002, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4003, + "name": "level", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 4004, + "name": "unsetLogLevel", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4005, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4006, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 4007, + "name": "activity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4008, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4009, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4010, + "name": "message", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4011, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 4012, + "name": "progress", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4013, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4014, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4015, + "name": "activityId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4016, + "name": "message", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 4017, + "name": "error", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4018, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4019, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4020, + "name": "messageOrError", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4021, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 4022, + "name": "failure", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4023, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4024, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4025, + "name": "activityId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4026, + "name": "message", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 4027, + "name": "success", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4028, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4029, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4030, + "name": "activityId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4031, + "name": "message", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 4032, + "name": "debug", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4033, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4034, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4035, + "name": "message", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 4036, + "name": "info", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4037, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4038, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4039, + "name": "message", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 4040, + "name": "warn", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4041, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4042, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4043, + "name": "message", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 4044, + "name": "log", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4045, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4046, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4047, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } } } ], + "groups": [ + { + "title": "Properties", + "children": [ + 3992, + 3996, + 4000, + 4004, + 4007, + 4012, + 4017, + 4022, + 4027, + 4032, + 4036, + 4040, + 4044 + ] + } + ] + } + } + }, + { + "id": 4048, + "name": "Constructor", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 4052, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 4049, + "name": "__type", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4050, + "name": "__type", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 4051, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + } + } + ], + "type": { + "type": "reference", + "target": 4052, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ] + } + } + }, + { + "id": 4053, + "name": "ConfigModule", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": 4943, + "name": "CommonTypes.ConfigModule", + "package": "@medusajs/types", + "qualifiedName": "ConfigModule" + } + }, + { + "id": 4483, + "name": "AdminListOrdersSelector", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on the retrieved orders." + } + ] + }, + "children": [ + { + "id": 4484, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4485, + "name": "new AdminListOrdersSelector", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4483, + "name": "AdminListOrdersSelector", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4486, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search orders' shipping address, first name, email, and display ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4487, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "ID to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4488, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statuses to filter orders by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4489, + "name": "fulfillment_status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Fulfillment statuses to filter orders by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4490, + "name": "payment_status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Payment statuses to filter orders by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4491, + "name": "display_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Display ID to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4492, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Cart ID to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4493, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Customer ID to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4494, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Email to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4495, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Regions to filter orders by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 4496, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Currency code to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4497, + "name": "tax_rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Tax rate to filter orders by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4498, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Sales channel IDs to filter orders by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4499, + "name": "canceled_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the orders' " + }, + { + "kind": "code", + "text": "`canceled_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 4500, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the orders' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 4501, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the orders' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4484 + ] + }, + { + "title": "Properties", + "children": [ + 4486, + 4487, + 4488, + 4489, + 4490, + 4491, + 4492, + 4493, + 4494, + 4495, + 4496, + 4497, + 4498, + 4499, + 4500, + 4501 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 911, + "name": "AdminGetOrdersParams" + } + ] + }, + { + "id": 4502, + "name": "OrdersReturnItem", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4503, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4504, + "name": "new OrdersReturnItem", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4502, + "name": "OrdersReturnItem", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4505, + "name": "item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Line Item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4506, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the Line Item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4507, + "name": "reason_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Return Reason to use." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4508, + "name": "note", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional note with information about the Return." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4503 + ] + }, + { + "title": "Properties", + "children": [ + 4505, + 4506, + 4507, + 4508 + ] + } + ] + }, + { + "id": 4068, + "name": "PriceListType", + "variant": "declaration", + "kind": 8, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of price list." + } + ] + }, + "children": [ + { + "id": 4069, + "name": "SALE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list is used for a sale." + } + ] + }, + "type": { + "type": "literal", + "value": "sale" + } + }, + { + "id": 4070, + "name": "OVERRIDE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list is used to override original prices for specific conditions." + } + ] + }, + "type": { + "type": "literal", + "value": "override" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 4069, + 4070 + ] + } + ] + }, + { + "id": 4071, + "name": "PriceListStatus", + "variant": "declaration", + "kind": 8, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The status of a price list." + } + ] + }, + "children": [ + { + "id": 4072, + "name": "ACTIVE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list is active, meaning its prices are applied to customers." + } + ] + }, + "type": { + "type": "literal", + "value": "active" + } + }, + { + "id": 4073, + "name": "DRAFT", + "variant": "declaration", + "kind": 16, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list is a draft, meaning its not yet applied to customers." + } + ] + }, + "type": { + "type": "literal", + "value": "draft" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 4072, + 4073 + ] + } + ] + }, + { + "id": 4074, + "name": "FilterablePriceListProps", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on the retrieved price lists." + } + ] + }, + "children": [ + { + "id": 4075, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4076, + "name": "new FilterablePriceListProps", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4074, + "name": "FilterablePriceListProps", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4077, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter price lists by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4078, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search terms to search price lists' description, name, and customer group's name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4079, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statuses to filter price lists by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4071, + "name": "PriceListStatus", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 4080, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name to filter price lists by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4081, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter price lists by their associated customer groups." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4082, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description to filter price lists by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4083, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Types to filter price lists by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4068, + "name": "PriceListType", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 4084, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the price lists' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 4085, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the price lists' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 4086, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the price lists' " + }, + { + "kind": "code", + "text": "`deleted_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4075 + ] + }, + { + "title": "Properties", + "children": [ + 4077, + 4078, + 4079, + 4080, + 4081, + 4082, + 4083, + 4084, + 4085, + 4086 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 1129, + "name": "AdminGetPriceListPaginationParams" + } + ] + }, + { + "id": 4087, + "name": "AdminPriceListPricesUpdateReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4088, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4089, + "name": "new AdminPriceListPricesUpdateReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4087, + "name": "AdminPriceListPricesUpdateReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4090, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the price." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4091, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Region for which the price is used. This is only required if `currecny_code` is not provided." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4092, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The 3 character ISO currency code for which the price will be used. This is only required if `region_id` is not provided." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4093, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Variant for which the price is used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4094, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount to charge for the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4095, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum quantity for which the price will be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4096, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum quantity for which the price will be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4088 + ] + }, + { + "title": "Properties", + "children": [ + 4090, + 4091, + 4092, + 4093, + 4094, + 4095, + 4096 + ] + } + ] + }, + { + "id": 4097, + "name": "AdminPriceListPricesCreateReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4098, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4099, + "name": "new AdminPriceListPricesCreateReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4097, + "name": "AdminPriceListPricesCreateReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4100, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Region for which the price is used. This is only required if `currecny_code` is not provided." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4101, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The 3 character ISO currency code for which the price will be used. This is only required if `region_id` is not provided." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4102, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount to charge for the Product Variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4103, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Variant for which the price is used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4104, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum quantity for which the price will be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4105, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum quantity for which the price will be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4098 + ] + }, + { + "title": "Properties", + "children": [ + 4100, + 4101, + 4102, + 4103, + 4104, + 4105 + ] + } + ] + }, + { + "id": 4106, + "name": "CreatePriceListInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4107, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4108, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4109, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4110, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 4068, + "name": "PriceListType", + "package": "@medusajs/medusa" + } + }, + { + "id": 4111, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 4071, + "name": "PriceListStatus", + "package": "@medusajs/medusa" + } + }, + { + "id": 4112, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4097, + "name": "AdminPriceListPricesCreateReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 4113, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 4114, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4115, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4115 + ] + } + ] + } + } + } + }, + { + "id": 4116, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 4117, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 4118, + "name": "includes_tax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4108, + 4109, + 4110, + 4111, + 4112, + 4113, + 4116, + 4117, + 4118 + ] + } + ] + } + } + }, + { + "id": 4119, + "name": "UpdatePriceListInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Pick" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/price-list.ts", + "qualifiedName": "PriceList" + }, + "name": "PriceList", + "package": "@medusajs/medusa" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "name" + }, + { + "type": "literal", + "value": "description" + }, + { + "type": "literal", + "value": "starts_at" + }, + { + "type": "literal", + "value": "ends_at" + }, + { + "type": "literal", + "value": "status" + }, + { + "type": "literal", + "value": "type" + }, + { + "type": "literal", + "value": "includes_tax" + } + ] + } + ], + "name": "Pick", + "package": "typescript" + } + ], + "name": "Partial", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 4120, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4121, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4087, + "name": "AdminPriceListPricesUpdateReq", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 4122, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 4123, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4124, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4124 + ] + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4121, + 4122 + ] + } + ] + } + } + ] + } + }, + { + "id": 4125, + "name": "PriceListPriceUpdateInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4126, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4127, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4128, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4129, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4130, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4131, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4132, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4133, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4127, + 4128, + 4129, + 4130, + 4131, + 4132, + 4133 + ] + } + ] + } + } + }, + { + "id": 4134, + "name": "PriceListPriceCreateInput", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4135, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4136, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4137, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4138, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4139, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4140, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4141, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4136, + 4137, + 4138, + 4139, + 4140, + 4141 + ] + } + ] + } + } + }, + { + "id": 4142, + "name": "PriceListLoadConfig", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4143, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4144, + "name": "include_discount_prices", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4145, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4146, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4147, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4148, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4144, + 4145, + 4146, + 4147, + 4148 + ] + } + ] + } + } + }, + { + "id": 4787, + "name": "PriceSelectionParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context to apply on retrieved prices." + } + ] + }, + "children": [ + { + "id": 4788, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4789, + "name": "new PriceSelectionParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4787, + "name": "PriceSelectionParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 3972, + "name": "FindParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 3971, + "name": "FindParams.constructor" + } + }, + { + "id": 4793, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3973, + "name": "FindParams.expand" + } + }, + { + "id": 4794, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 3974, + "name": "FindParams.fields" + } + }, + { + "id": 4790, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a cart ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4791, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a region ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4792, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a currency code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4788 + ] + }, + { + "title": "Properties", + "children": [ + 4793, + 4794, + 4790, + 4791, + 4792 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 3970, + "name": "FindParams", + "package": "@medusajs/medusa" + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 2483, + "name": "StoreGetProductsPaginationParams" + }, + { + "type": "reference", + "target": 2598, + "name": "StoreGetVariantsVariantParams" + }, + { + "type": "reference", + "target": 2607, + "name": "StoreGetVariantsParams" + }, + { + "type": "reference", + "target": 4770, + "name": "AdminPriceSelectionParams" + } + ] + }, + { + "id": 4770, + "name": "AdminPriceSelectionParams", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context to apply on retrieved prices by a user admin." + } + ] + }, + "children": [ + { + "id": 4771, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4772, + "name": "new AdminPriceSelectionParams", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4770, + "name": "AdminPriceSelectionParams", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": 4789, + "name": "PriceSelectionParams.constructor" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 4788, + "name": "PriceSelectionParams.constructor" + } + }, + { + "id": 4777, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated relations that should be expanded in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4793, + "name": "PriceSelectionParams.expand" + } + }, + { + "id": 4778, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Comma-separated fields that should be included in the returned data." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4794, + "name": "PriceSelectionParams.fields" + } + }, + { + "id": 4774, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a cart ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4790, + "name": "PriceSelectionParams.cart_id" + } + }, + { + "id": 4775, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a region ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4791, + "name": "PriceSelectionParams.region_id" + } + }, + { + "id": 4776, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a currency code." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 4792, + "name": "PriceSelectionParams.currency_code" + } + }, + { + "id": 4773, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Retrieve prices for a customer ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4771 + ] + }, + { + "title": "Properties", + "children": [ + 4777, + 4778, + 4774, + 4775, + 4776, + 4773 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 4787, + "name": "PriceSelectionParams", + "package": "@medusajs/medusa" + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 2074, + "name": "AdminGetVariantsParams" + } + ] + }, + { + "id": 5034, + "name": "ProductVariantPricing", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Pricing fields for product variants." + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reflection", + "declaration": { + "id": 5035, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5036, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of prices." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", + "qualifiedName": "MoneyAmount" + }, + "name": "MoneyAmount", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 5037, + "name": "original_price", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The original price of the variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5038, + "name": "calculated_price", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The lowest price among the retrieved prices." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5039, + "name": "original_price_includes_tax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the " + }, + { + "kind": "code", + "text": "`original_price`" + }, + { + "kind": "text", + "text": " field includes taxes." + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "text", + "text": "tax_inclusive_pricing" + } + ] + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5040, + "name": "calculated_price_includes_tax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the " + }, + { + "kind": "code", + "text": "`calculated_price`" + }, + { + "kind": "text", + "text": " field includes taxes." + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "text", + "text": "tax_inclusive_pricing" + } + ] + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5041, + "name": "calculated_price_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Either " + }, + { + "kind": "code", + "text": "`default`" + }, + { + "kind": "text", + "text": " if the " + }, + { + "kind": "code", + "text": "`calculated_price`" + }, + { + "kind": "text", + "text": " is the original price, or the type of the price list applied, if any." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5036, + 5037, + 5038, + 5039, + 5040, + 5041 + ] + } + ] + } + }, + { + "type": "reference", + "target": 5171, + "name": "TaxedPricing", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 5171, + "name": "TaxedPricing", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Pricing fields related to taxes." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 5172, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5173, + "name": "original_price_incl_tax", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price after applying the tax amount on the original price." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5174, + "name": "calculated_price_incl_tax", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price after applying the tax amount on the calculated price." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5175, + "name": "original_tax", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax amount applied to the original price." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5176, + "name": "calculated_tax", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax amount applied to the calculated price." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5177, + "name": "tax_rates", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of tax rates." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 4899, + "name": "TaxServiceRate", + "package": "@medusajs/medusa" + } + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5173, + 5174, + 5175, + 5176, + 5177 + ] + } + ] + } + } + }, + { + "id": 5042, + "name": "ShippingOptionPricing", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 5043, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5044, + "name": "price_incl_tax", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Price including taxes" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5045, + "name": "tax_rates", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of applied tax rates" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 4899, + "name": "TaxServiceRate", + "package": "@medusajs/medusa" + } + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5046, + "name": "tax_amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The taxes applied." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5044, + 5045, + 5046 + ] + } + ] + } + } + }, + { + "id": 4806, + "name": "PricedShippingOption", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-option.ts", + "qualifiedName": "ShippingOption" + }, + "name": "ShippingOption", + "package": "@medusajs/medusa" + } + ], + "name": "Partial", + "package": "typescript" + }, + { + "type": "reference", + "target": 5042, + "name": "ShippingOptionPricing", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 4769, + "name": "PricedVariant", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-variant.ts", + "qualifiedName": "ProductVariant" + }, + "name": "ProductVariant", + "package": "@medusajs/medusa" + } + ], + "name": "Partial", + "package": "typescript" + }, + { + "type": "reference", + "target": 5034, + "name": "ProductVariantPricing", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 4569, + "name": "PricedProduct", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "Product" + }, + "name": "Product", + "package": "@medusajs/medusa" + } + ], + "name": "Partial", + "package": "typescript" + }, + { + "type": "literal", + "value": "variants" + } + ], + "name": "Omit", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 4570, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4571, + "name": "variants", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product variants and their prices." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4769, + "name": "PricedVariant", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4571 + ] + } + ] + } + } + ] + } + }, + { + "id": 4557, + "name": "AdminProductCategoriesReqBase", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4558, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4559, + "name": "new AdminProductCategoriesReqBase", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4557, + "name": "AdminProductCategoriesReqBase", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4560, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4561, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4562, + "name": "is_internal", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4563, + "name": "is_active", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4564, + "name": "parent_category_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4558 + ] + }, + { + "title": "Properties", + "children": [ + 4560, + 4561, + 4562, + 4563, + 4564 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 1187, + "name": "AdminPostProductCategoriesReq" + }, + { + "type": "reference", + "target": 1202, + "name": "AdminPostProductCategoriesCategoryReq" + } + ] + }, + { + "id": 4565, + "name": "ProductBatchProductCategory", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4566, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4567, + "name": "new ProductBatchProductCategory", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4565, + "name": "ProductBatchProductCategory", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4568, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4566 + ] + }, + { + "title": "Properties", + "children": [ + 4568 + ] + } + ] + }, + { + "id": 4673, + "name": "ProductVariantPricesUpdateReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4674, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4675, + "name": "new ProductVariantPricesUpdateReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4673, + "name": "ProductVariantPricesUpdateReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4676, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Price. If provided, the existing price will be updated. Otherwise, a new price will be created." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4677, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Region the price will be used in. This is only required if `currency_code` is not provided." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4678, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The 3 character ISO currency code the price will be used in. This is only required if `region_id` is not provided." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4679, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4680, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum quantity required to be added to the cart for the price to be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4681, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum quantity required to be added to the cart for the price to be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4674 + ] + }, + { + "title": "Properties", + "children": [ + 4676, + 4677, + 4678, + 4679, + 4680, + 4681 + ] + } + ] + }, + { + "id": 4616, + "name": "ProductVariantPricesCreateReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4617, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4618, + "name": "new ProductVariantPricesCreateReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4616, + "name": "ProductVariantPricesCreateReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4619, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the Region the price will be used in. This is only required if `currency_code` is not provided." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4620, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The 3 character ISO currency code the price will be used in. This is only required if `region_id` is not provided." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4621, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4622, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum quantity required to be added to the cart for the price to be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4623, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum quantity required to be added to the cart for the price to be used." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4617 + ] + }, + { + "title": "Properties", + "children": [ + 4619, + 4620, + 4621, + 4622, + 4623 + ] + } + ] + }, + { + "id": 4629, + "name": "FilterableProductProps", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on retrieved products." + } + ] + }, + "children": [ + { + "id": 4630, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4631, + "name": "new FilterableProductProps", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4629, + "name": "FilterableProductProps", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4632, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter products by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 4633, + "name": "q", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Search term to search products' title, description, variants' title and sku, and collections' title." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4634, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Statuses to filter products by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product.ts", + "qualifiedName": "ProductStatus" + }, + "name": "ProductStatus", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 4635, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated price lists' ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4636, + "name": "collection_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated product collection's ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4637, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated tags' value." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4638, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Title to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4639, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4640, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Handle to filter products by." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4641, + "name": "is_giftcard", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by whether they're gift cards." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4642, + "name": "type_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated product type's ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4643, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated sales channels' ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4644, + "name": "discount_condition_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated discount condition's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4645, + "name": "category_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter products by their associated product category's ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4646, + "name": "include_category_children", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to include product category children in the response." + } + ], + "blockTags": [ + { + "tag": "@featureFlag", + "content": [ + { + "kind": "text", + "text": "product_categories" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4647, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the products' " + }, + { + "kind": "code", + "text": "`created_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 4648, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the products' " + }, + { + "kind": "code", + "text": "`updated_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + }, + { + "id": 4649, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Date filters to apply on the products' " + }, + { + "kind": "code", + "text": "`deleted_at`" + }, + { + "kind": "text", + "text": " date." + } + ] + }, + "type": { + "type": "reference", + "target": 3918, + "name": "DateComparisonOperator", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4630 + ] + }, + { + "title": "Properties", + "children": [ + 4632, + 4633, + 4634, + 4635, + 4636, + 4637, + 4638, + 4639, + 4640, + 4641, + 4642, + 4643, + 4644, + 4645, + 4646, + 4647, + 4648, + 4649 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 1407, + "name": "AdminGetProductsParams" + } + ] + }, + { + "id": 4582, + "name": "ProductSalesChannelReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4583, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4584, + "name": "new ProductSalesChannelReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4582, + "name": "ProductSalesChannelReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4585, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of an existing Sales channel." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4583 + ] + }, + { + "title": "Properties", + "children": [ + 4585 + ] + } + ] + }, + { + "id": 4586, + "name": "ProductProductCategoryReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4587, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4588, + "name": "new ProductProductCategoryReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4586, + "name": "ProductProductCategoryReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4589, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a Product Category." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4587 + ] + }, + { + "title": "Properties", + "children": [ + 4589 + ] + } + ] + }, + { + "id": 4577, + "name": "ProductTagReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4578, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4579, + "name": "new ProductTagReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4577, + "name": "ProductTagReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4580, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of an existing Product Tag. If not provided, a new product tag will be created." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4581, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the Tag. If the `id` is provided, the value of the existing tag will be updated." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4578 + ] + }, + { + "title": "Properties", + "children": [ + 4580, + 4581 + ] + } + ] + }, + { + "id": 4572, + "name": "ProductTypeReq", + "variant": "declaration", + "kind": 128, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of a product type, used to create or update an existing product type." + } + ] + }, + "children": [ + { + "id": 4573, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4574, + "name": "new ProductTypeReq", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4572, + "name": "ProductTypeReq", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4575, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product type. It's only required when referring to an existing product type." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4576, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the product type." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4573 + ] + }, + { + "title": "Properties", + "children": [ + 4575, + 4576 + ] + } + ] + }, + { + "id": 4851, + "name": "RequestContext", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4852, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4853, + "name": "ip", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4853 + ] + } + ] + } + } + }, + { + "id": 4149, + "name": "MedusaRequest", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 4152, + "name": "validatedQuery", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 3901, + "name": "RequestQueryFields", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Request.validatedQuery" + } + }, + { + "id": 4153, + "name": "validatedBody", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Request.validatedBody" + } + }, + { + "id": 4154, + "name": "listConfig", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 3854, + "typeArguments": [ + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "FindConfig", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Request.listConfig" + } + }, + { + "id": 4155, + "name": "retrieveConfig", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 3854, + "typeArguments": [ + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "FindConfig", + "package": "@medusajs/medusa" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Request.retrieveConfig" + } + }, + { + "id": 4156, + "name": "filterableFields", + "variant": "declaration", + "kind": 1024, + "flags": {}, "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" + "qualifiedName": "Record" }, "typeArguments": [ { "type": "intrinsic", - "name": "void" + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" } ], - "name": "Promise", + "name": "Record", "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Request.filterableFields" } + }, + { + "id": 4157, + "name": "allowedProperties", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Request.allowedProperties" + } + }, + { + "id": 4158, + "name": "includes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "boolean" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Request.includes" + } + }, + { + "id": 4159, + "name": "errors", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Request.errors" + } + }, + { + "id": 4150, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "unknown", + "name": "(User | Customer) & { customer_id?: string | undefined; userId?: string | undefined; }" + }, + "overwrites": { + "type": "reference", + "target": -1, + "name": "Request.user" + } + }, + { + "id": 4151, + "name": "scope", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 4883, + "name": "MedusaContainer", + "package": "medusa-core-utils" + }, + "overwrites": { + "type": "reference", + "target": -1, + "name": "Request.scope" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4152, + 4153, + 4154, + 4155, + 4156, + 4157, + 4158, + 4159, + 4150, + 4151 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Request" + }, + "name": "Request", + "package": "@types/express", + "qualifiedName": "e.Request" } ] }, { - "id": 2622, - "name": "authenticate", + "id": 4160, + "name": "MedusaResponse", "variant": "declaration", - "kind": 64, + "kind": 2097152, "flags": {}, - "signatures": [ - { - "id": 2623, - "name": "authenticate", - "variant": "signature", - "kind": 4096, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.Response" + }, + "name": "Response", + "package": "@types/express", + "qualifiedName": "e.Response" + } + }, + { + "id": 4161, + "name": "MedusaNextFunction", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/express/index.d.ts", + "qualifiedName": "e.NextFunction" + }, + "name": "NextFunction", + "package": "@types/express", + "qualifiedName": "e.NextFunction" + } + }, + { + "id": 4162, + "name": "MedusaRequestHandler", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4163, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, + "signatures": [ + { + "id": 4164, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4165, + "name": "req", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4149, + "name": "MedusaRequest", + "package": "@medusajs/medusa" + } + }, + { + "id": 4166, + "name": "res", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4160, + "name": "MedusaResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 4167, + "name": "next", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4161, + "name": "MedusaNextFunction", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "void" + } + ] + } + } + ] + } + } + }, + { + "id": 4687, + "name": "ProductBatchSalesChannel", + "variant": "declaration", + "kind": 128, + "flags": {}, + "children": [ + { + "id": 4688, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4689, + "name": "new ProductBatchSalesChannel", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 4687, + "name": "ProductBatchSalesChannel", + "package": "@medusajs/medusa" + } + } + ] + }, + { + "id": 4690, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the sales channel" + } + ] + }, "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.RequestHandler" + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 4688 + ] + }, + { + "title": "Properties", + "children": [ + 4690 + ] + } + ] + }, + { + "id": 4168, + "name": "ScheduledJobConfig", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 4173, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 4169, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4170, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the job" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", - "qualifiedName": "ParamsDictionary" - }, - "name": "ParamsDictionary", - "package": "@types/express-serve-static-core" + { + "id": 4171, + "name": "schedule", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cron schedule of the job, e.g. " + }, + { + "kind": "code", + "text": "`0 0 * * *`" + }, + { + "kind": "text", + "text": " for running every day at midnight." + } + ] }, - { + "type": { "type": "intrinsic", - "name": "any" + "name": "string" + } + }, + { + "id": 4172, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, - { - "type": "intrinsic", - "name": "any" + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional data object to pass to the job handler" + } + ] }, - { + "type": { "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", - "qualifiedName": "QueryString.ParsedQs" - }, - "name": "ParsedQs", - "package": "@types/qs", - "qualifiedName": "QueryString.ParsedQs" + "target": 4173, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4170, + 4171, + 4172 + ] + } + ] + } + } + }, + { + "id": 4174, + "name": "ScheduledJobArgs", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 4179, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 4175, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4176, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 4177, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, - { + "type": { + "type": "reference", + "target": 4179, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + }, + { + "id": 4178, + "name": "pluginOptions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", @@ -115432,68 +109250,383 @@ }, { "type": "intrinsic", - "name": "any" + "name": "unknown" } ], "name": "Record", "package": "typescript" } - ], - "name": "RequestHandler", - "package": "@types/express", - "qualifiedName": "e.RequestHandler" + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4176, + 4177, + 4178 + ] + } + ] + } + } + }, + { + "id": 5033, + "name": "ModulesResponse", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reference", + "target": 5167, + "name": "sdkModulesResponse", + "package": "@medusajs/types", + "qualifiedName": "ModulesResponse" + } + }, + { + "id": 4760, + "name": "ExtendedStoreDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/store.ts", + "qualifiedName": "Store" + }, + "name": "Store", + "package": "@medusajs/medusa" + }, + { + "type": "reflection", + "declaration": { + "id": 4761, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4762, + "name": "payment_providers", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The store's payment providers." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/payment-provider.ts", + "qualifiedName": "PaymentProvider" + }, + "name": "PaymentProvider", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 4763, + "name": "fulfillment_providers", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The store's fulfillment providers." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/fulfillment-provider.ts", + "qualifiedName": "FulfillmentProvider" + }, + "name": "FulfillmentProvider", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 4764, + "name": "feature_flags", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The feature flags enabled in the store's backend." + } + ] + }, + "type": { + "type": "reference", + "target": 5029, + "name": "FeatureFlagsResponse", + "package": "@medusajs/medusa" + } + }, + { + "id": 4765, + "name": "modules", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The modules installed in the store's backend." + } + ] + }, + "type": { + "type": "reference", + "target": 5033, + "name": "ModulesResponse", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4762, + 4763, + 4764, + 4765 + ] + } + ] + } } + ] + } + }, + { + "id": 4962, + "name": "SubscriberContext", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 4963, + "name": "subscriberId", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4963 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" } ] }, { - "id": 2624, - "name": "authenticateCustomer", + "id": 4180, + "name": "SubscriberConfig", "variant": "declaration", - "kind": 64, + "kind": 2097152, "flags": {}, - "signatures": [ - { - "id": 2625, - "name": "authenticateCustomer", - "variant": "signature", - "kind": 4096, + "type": { + "type": "reflection", + "declaration": { + "id": 4181, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.RequestHandler" + "children": [ + { + "id": 4182, + "name": "event", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } }, - "typeArguments": [ - { + { + "id": 4183, + "name": "context", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", - "qualifiedName": "ParamsDictionary" - }, - "name": "ParamsDictionary", - "package": "@types/express-serve-static-core" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - }, - { + "target": 4962, + "name": "SubscriberContext", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4182, + 4183 + ] + } + ] + } + } + }, + { + "id": 4184, + "name": "SubscriberArgs", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 4190, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 4185, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4186, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", - "qualifiedName": "QueryString.ParsedQs" - }, - "name": "ParsedQs", - "package": "@types/qs", - "qualifiedName": "QueryString.ParsedQs" - }, - { + "target": 4190, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + }, + { + "id": 4187, + "name": "eventName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4188, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 4189, + "name": "pluginOptions", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", @@ -115506,29 +109639,860 @@ }, { "type": "intrinsic", - "name": "any" + "name": "unknown" } ], "name": "Record", "package": "typescript" } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4186, + 4187, + 4188, + 4189 + ] + } + ] + } + } + }, + { + "id": 4899, + "name": "TaxServiceRate", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate object as configured in Medusa. These may have an unspecified\nnumerical rate as they may be used for lookup purposes in the tax provider\nplugin." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 4900, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4901, + "name": "rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4902, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4903, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's code." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4901, + 4902, + 4903 + ] + } + ] + } + } + }, + { + "id": 5062, + "name": "ProviderShippingMethodTaxLine", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax line properties for a given shipping method." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 5063, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5064, + "name": "rate", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 5065, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5066, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax code." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5067, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds any necessary additional data to be added to the shipping method tax lines." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 5068, + "name": "shipping_method_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5064, + 5065, + 5066, + 5067, + 5068 + ] + } + ] + } + } + }, + { + "id": 5055, + "name": "ProviderLineItemTaxLine", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax line properties for a given line item." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 5056, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5057, + "name": "rate", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 5058, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rate's name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5059, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax code." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5060, + "name": "item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5061, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds any necessary additional data to be added to the line item tax lines." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5057, + 5058, + 5059, + 5060, + 5061 + ] + } + ] + } + } + }, + { + "id": 4913, + "name": "ProviderTaxLine", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A union type of the possible provider tax lines." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 5055, + "name": "ProviderLineItemTaxLine", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": 5062, + "name": "ProviderShippingMethodTaxLine", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 5047, + "name": "GiftCardAllocation", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of a gift card allocated to a line item" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 5048, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5049, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 5050, + "name": "unit_amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5049, + 5050 + ] + } + ] + } + } + }, + { + "id": 5051, + "name": "DiscountAllocation", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of a discount allocated to a line item" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 5052, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5053, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 5054, + "name": "unit_amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5053, + 5054 + ] + } + ] + } + } + }, + { + "id": 4906, + "name": "LineAllocationsMap", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A map of line item ids and its corresponding gift card and discount\nallocations" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 4907, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "indexSignature": { + "id": 4908, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "parameters": [ + { + "id": 4909, + "name": "K", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } ], - "name": "RequestHandler", - "package": "@types/express", - "qualifiedName": "e.RequestHandler" + "type": { + "type": "reflection", + "declaration": { + "id": 4910, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4911, + "name": "gift_card", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The gift card applied on the line item." + } + ] + }, + "type": { + "type": "reference", + "target": 5047, + "name": "GiftCardAllocation", + "package": "@medusajs/medusa" + } + }, + { + "id": 4912, + "name": "discount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The discount applied on the line item." + } + ] + }, + "type": { + "type": "reference", + "target": 5051, + "name": "DiscountAllocation", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4911, + 4912 + ] + } + ] + } + } + } + } + } + }, + { + "id": 4201, + "name": "buildQuery", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4202, + "name": "buildQuery", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to build TypeORM queries." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The QueryBuilderConfig" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 4203, + "name": "TWhereKeys", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 4204, + "name": "TEntity", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "parameters": [ + { + "id": 4205, + "name": "selector", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The selector" + } + ] + }, + "type": { + "type": "reference", + "target": 4203, + "name": "TWhereKeys", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + }, + { + "id": 4206, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The config" + } + ] + }, + "type": { + "type": "reference", + "target": 3854, + "typeArguments": [ + { + "type": "reference", + "target": 4204, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "FindConfig", + "package": "@medusajs/medusa" + }, + "defaultValue": "{}" + } + ], + "type": { + "type": "reference", + "target": 3864, + "typeArguments": [ + { + "type": "reference", + "target": 4204, + "name": "TEntity", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "ExtendedFindConfig", + "package": "@medusajs/medusa" } } ] }, { - "id": 4200, + "id": 4207, "name": "buildLegacyFieldsListFrom", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { - "id": 4201, + "id": 4208, "name": "buildLegacyFieldsListFrom", "variant": "signature", "kind": 4096, @@ -115563,7 +110527,7 @@ }, "typeParameter": [ { - "id": 4202, + "id": 4209, "name": "TEntity", "variant": "typeParam", "kind": 131072, @@ -115572,7 +110536,7 @@ ], "parameters": [ { - "id": 4203, + "id": 4210, "name": "input", "variant": "param", "kind": 32768, @@ -115589,7 +110553,7 @@ "typeArguments": [ { "type": "reference", - "target": 4202, + "target": 4209, "name": "TEntity", "package": "@medusajs/medusa", "refersToTypeParameter": true @@ -115607,7 +110571,7 @@ "typeArguments": [ { "type": "reference", - "target": 4202, + "target": 4209, "name": "TEntity", "package": "@medusajs/medusa", "refersToTypeParameter": true @@ -115625,7 +110589,7 @@ "typeArguments": [ { "type": "reference", - "target": 4202, + "target": 4209, "name": "TEntity", "package": "@medusajs/medusa", "refersToTypeParameter": true @@ -115643,7 +110607,7 @@ "typeArguments": [ { "type": "reference", - "target": 4202, + "target": 4209, "name": "TEntity", "package": "@medusajs/medusa", "refersToTypeParameter": true @@ -115664,7 +110628,7 @@ "operator": "keyof", "target": { "type": "reference", - "target": 4202, + "target": 4209, "name": "TEntity", "package": "@medusajs/medusa", "refersToTypeParameter": true @@ -115675,1724 +110639,102 @@ ] }, { - "id": 4194, - "name": "buildQuery", + "id": 4211, + "name": "addOrderToSelect", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { - "id": 4195, - "name": "buildQuery", + "id": 4212, + "name": "addOrderToSelect", "variant": "signature", "kind": 4096, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to build TypeORM queries." - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "The QueryBuilderConfig" - } - ] - } - ] - }, "typeParameter": [ { - "id": 4196, - "name": "TWhereKeys", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 4197, + "id": 4213, "name": "TEntity", "variant": "typeParam", "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } + "flags": {} } ], "parameters": [ { - "id": 4198, - "name": "selector", + "id": 4214, + "name": "order", "variant": "param", "kind": 32768, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The selector" - } - ] - }, "type": { "type": "reference", - "target": 4196, - "name": "TWhereKeys", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - { - "id": 4199, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The config" - } - ] - }, - "type": { - "type": "reference", - "target": 3847, + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsOrder.d.ts", + "qualifiedName": "FindOptionsOrder" + }, "typeArguments": [ { "type": "reference", - "target": 4197, + "target": 4213, "name": "TEntity", "package": "@medusajs/medusa", "refersToTypeParameter": true } ], - "name": "FindConfig", - "package": "@medusajs/medusa" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 3857, - "typeArguments": [ - { - "type": "reference", - "target": 4197, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "ExtendedFindConfig", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4212, - "name": "calculatePriceTaxAmount", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4213, - "name": "calculatePriceTaxAmount", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Return the tax amount that\n\n- is includes in the price if it is tax inclusive\n- will be applied on to the price if it is tax exclusive" - } - ] - }, - "parameters": [ - { - "id": 4214, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 4215, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 4217, - "name": "includesTax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 4216, - "name": "price", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4218, - "name": "taxRate", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4217, - 4216, - 4218 - ] - } - ] - } - } - } - ], - "type": { - "type": "intrinsic", - "name": "number" - } - } - ] - }, - { - "id": 2637, - "name": "canAccessBatchJob", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 2638, - "name": "canAccessBatchJob", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2639, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 2640, - "name": "res", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 2641, - "name": "next", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 4271, - "name": "categoryMatchesScope", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4272, - "name": "categoryMatchesScope", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4273, - "name": "category", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A product category can be used to categorize products into a hierarchy of categories." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", - "qualifiedName": "ProductCategory" - }, - "name": "ProductCategory", - "package": "@medusajs/medusa" - } - }, - { - "id": 4274, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", - "qualifiedName": "FindOptionsWhere" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", - "qualifiedName": "ProductCategory" - }, - "name": "ProductCategory", - "package": "@medusajs/medusa" - } - ], - "name": "FindOptionsWhere", + "name": "FindOptionsOrder", "package": "typeorm" } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 4219, - "name": "cleanResponseData", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4220, - "name": "cleanResponseData", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter response data to contain props specified in the " - }, - { - "kind": "code", - "text": "`allowedProperties`" - }, - { - "kind": "text", - "text": ".\nYou can read more in the transformQuery middleware utility methods." - } - ] - }, - "typeParameter": [ + }, { - "id": 4221, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 4222, - "name": "data", + "id": 4215, + "name": "select", "variant": "param", "kind": 32768, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "record or an array of records in the response" - } - ] - }, "type": { - "type": "reference", - "target": 4221, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - { - "id": 4223, - "name": "fields", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "record props allowed in the response" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 4221, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "tuple" - }, - "trueType": { - "type": "array", - "elementType": { "type": "reference", "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsSelect.d.ts", + "qualifiedName": "FindOptionsSelect" }, "typeArguments": [ { "type": "reference", - "target": 4221, - "name": "T", + "target": 4213, + "name": "TEntity", "package": "@medusajs/medusa", "refersToTypeParameter": true } ], - "name": "Partial", - "package": "typescript" - } - }, - "falseType": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "reference", - "target": 4221, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "Partial", - "package": "typescript" - } - } - } - ] - }, - { - "id": 4224, - "name": "csvCellContentFormatter", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4225, - "name": "csvCellContentFormatter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4226, - "name": "str", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 4227, - "name": "csvRevertCellContentFormatter", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4228, - "name": "csvRevertCellContentFormatter", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4229, - "name": "str", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 2647, - "name": "doesConditionBelongToDiscount", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 2648, - "name": "doesConditionBelongToDiscount", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2649, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 2650, - "name": "res", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 2651, - "name": "next", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2626, - "name": "errorHandler", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 2627, - "name": "errorHandler", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2628, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2629, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2630, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4813, - "name": "MedusaError", - "package": "medusa-core-utils" - } - }, - { - "id": 2631, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Request" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", - "qualifiedName": "ParamsDictionary" - }, - "name": "ParamsDictionary", - "package": "@types/express-serve-static-core" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", - "qualifiedName": "QueryString.ParsedQs" - }, - "name": "ParsedQs", - "package": "@types/qs", - "qualifiedName": "QueryString.ParsedQs" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "Request", - "package": "@types/express", - "qualifiedName": "e.Request" - } - }, - { - "id": 2632, - "name": "res", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Response" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "Response", - "package": "@types/express", - "qualifiedName": "e.Response" - } - }, - { - "id": 2633, - "name": "next", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.NextFunction" - }, - "name": "NextFunction", - "package": "@types/express", - "qualifiedName": "e.NextFunction" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ] - }, - { - "id": 3833, - "name": "extendedFindParamsMixin", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 3834, - "name": "extendedFindParamsMixin", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3835, - "name": "__namedParameters", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 3836, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 3837, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 3838, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 3837, - 3838 - ] - } - ] - } - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reference", - "target": 3977, - "typeArguments": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 3963, - "name": "FindParams", - "package": "@medusajs/medusa" - }, - { - "type": "reference", - "target": 3968, - "name": "FindPaginationParams", - "package": "@medusajs/medusa" - } - ] - } - ], - "name": "ClassConstructor", - "package": "@medusajs/medusa" - } - } - ] - }, - { - "id": 4275, - "name": "fetchCategoryDescendantsIds", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4276, - "name": "fetchCategoryDescendantsIds", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4277, - "name": "productCategory", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A product category can be used to categorize products into a hierarchy of categories." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", - "qualifiedName": "ProductCategory" - }, - "name": "ProductCategory", - "package": "@medusajs/medusa" - } - }, - { - "id": 4278, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", - "qualifiedName": "FindOptionsWhere" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", - "qualifiedName": "ProductCategory" - }, - "name": "ProductCategory", - "package": "@medusajs/medusa" - } - ], - "name": "FindOptionsWhere", + "name": "FindOptionsSelect", "package": "typeorm" } } ], - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ] - }, - { - "id": 4244, - "name": "formatException", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4245, - "name": "formatException", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4246, - "name": "err", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": 4813, - "name": "MedusaError", - "package": "medusa-core-utils" - } - } - ] - }, - { - "id": 4247, - "name": "generateEntityId", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4248, - "name": "generateEntityId", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Generate a composed id based on the input parameters and return either the is if it exists or the generated one." - } - ] - }, - "parameters": [ - { - "id": 4249, - "name": "idProperty", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 4250, - "name": "prefix", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], "type": { "type": "intrinsic", - "name": "string" + "name": "void" } } ] }, { - "id": 2642, - "name": "getRequestedBatchJob", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 2643, - "name": "getRequestedBatchJob", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2644, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 2645, - "name": "res", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 2646, - "name": "next", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 4279, - "name": "getVariantsFromPriceList", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4280, - "name": "getVariantsFromPriceList", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4281, - "name": "container", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4878, - "name": "MedusaContainer", - "package": "@medusajs/types" - } - }, - { - "id": 4282, - "name": "priceListId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 4981, - "name": "ProductVariantDTO", - "package": "@medusajs/types" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 4251, - "name": "hasChanges", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4252, - "name": "hasChanges", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Compare two objects and return true if there is changes detected from obj2 compared to obj1" - } - ] - }, - "typeParameter": [ - { - "id": 4253, - "name": "T1", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Object" - }, - "name": "Object", - "package": "typescript" - } - }, - { - "id": 4254, - "name": "T2", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Object" - }, - "name": "Object", - "package": "typescript" - } - } - ], - "parameters": [ - { - "id": 4255, - "name": "obj1", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4253, - "name": "T1", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - }, - { - "id": 4256, - "name": "obj2", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4254, - "name": "T2", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ] - }, - { - "id": 4257, - "name": "isDate", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4258, - "name": "isDate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4259, - "name": "value", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "value", - "asserts": false, - "targetType": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - } - } - ] - }, - { - "id": 4260, - "name": "isObject", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4261, - "name": "isObject", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4262, - "name": "obj", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "obj", - "asserts": false, - "targetType": { - "type": "intrinsic", - "name": "object" - } - } - } - ] - }, - { - "id": 3240, - "name": "isPaymentProcessorError", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 3241, - "name": "isPaymentProcessorError", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 3242, - "name": "obj", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "obj", - "asserts": false, - "targetType": { - "type": "reference", - "target": 3257, - "name": "PaymentProcessorError", - "package": "@medusajs/medusa" - } - } - } - ] - }, - { - "id": 4263, - "name": "isString", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4264, - "name": "isString", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4265, - "name": "val", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "predicate", - "name": "val", - "asserts": false, - "targetType": { - "type": "intrinsic", - "name": "string" - } - } - } - ] - }, - { - "id": 4283, - "name": "listProducts", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4284, - "name": "listProducts", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4285, - "name": "container", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4878, - "name": "MedusaContainer", - "package": "@medusajs/types" - } - }, - { - "id": 4286, - "name": "filterableFields", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 4287, - "name": "listConfig", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 2652, - "name": "normalizeQuery", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 2653, - "name": "normalizeQuery", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Normalize an input query, especially from array like query params to an array type\ne.g: /admin/orders/?fields[]=id,status,cart_id becomes { fields: [\"id\", \"status\", \"cart_id\"] }" - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 2654, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2655, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2656, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Request" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", - "qualifiedName": "ParamsDictionary" - }, - "name": "ParamsDictionary", - "package": "@types/express-serve-static-core" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", - "qualifiedName": "QueryString.ParsedQs" - }, - "name": "ParsedQs", - "package": "@types/qs", - "qualifiedName": "QueryString.ParsedQs" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "Request", - "package": "@types/express", - "qualifiedName": "e.Request" - } - }, - { - "id": 2657, - "name": "res", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Response" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "Response", - "package": "@types/express", - "qualifiedName": "e.Response" - } - }, - { - "id": 2658, - "name": "next", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.NextFunction" - }, - "name": "NextFunction", - "package": "@types/express", - "qualifiedName": "e.NextFunction" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ] - }, - { - "id": 4209, + "id": 4216, "name": "nullableValue", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { - "id": 4210, + "id": 4217, "name": "nullableValue", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4211, + "id": 4218, "name": "value", "variant": "param", "kind": 32768, @@ -117422,91 +110764,15 @@ ] }, { - "id": 4266, - "name": "omitDeep", + "id": 4219, + "name": "calculatePriceTaxAmount", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { - "id": 4267, - "name": "omitDeep", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 4268, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "object" - }, - "default": { - "type": "intrinsic", - "name": "object" - } - } - ], - "parameters": [ - { - "id": 4269, - "name": "input", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 4270, - "name": "excludes", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": 4268, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ] - }, - { - "id": 4184, - "name": "registerOverriddenValidators", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4185, - "name": "registerOverriddenValidators", + "id": 4220, + "name": "calculatePriceTaxAmount", "variant": "signature", "kind": 4096, "flags": {}, @@ -117514,342 +110780,40 @@ "summary": [ { "kind": "text", - "text": "When overriding a validator, you can register it to be used instead of the original one.\nFor example, the place where you are overriding the core validator, you can call this function" - } - ], - "blockTags": [ - { - "tag": "@example", - "content": [ - { - "kind": "code", - "text": "```ts\n// /src/api/routes/admin/products/create-product.ts\nimport { registerOverriddenValidators } from \"@medusajs/medusa\"\nimport { AdminPostProductsReq as MedusaAdminPostProductsReq } from \"@medusajs/medusa/dist/api/routes/admin/products/create-product\"\nimport { IsString } from \"class-validator\"\n\nclass AdminPostProductsReq extends MedusaAdminPostProductsReq {\n @IsString()\n test: string\n}\n\nregisterOverriddenValidators(AdminPostProductsReq)\n```" - } - ] + "text": "Return the tax amount that\n\n- is includes in the price if it is tax inclusive\n- will be applied on to the price if it is tax exclusive" } ] }, "parameters": [ { - "id": 4186, - "name": "extendedValidator", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4976, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Constructor", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 4294, - "name": "remoteQueryFetchData", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4295, - "name": "remoteQueryFetchData", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4296, - "name": "container", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4878, - "name": "MedusaContainer", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 4297, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 4298, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 4299, - "name": "expand", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 4300, - "name": "keyField", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 4301, - "name": "ids", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 4302, - "name": "relationship", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ] - }, - { - "id": 4303, - "name": "removeUndefinedProperties", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 4304, - "name": "removeUndefinedProperties", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 4305, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "object" - } - } - ], - "parameters": [ - { - "id": 4306, - "name": "inputObj", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4305, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 4305, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - } - ] - }, - { - "id": 2659, - "name": "requireCustomerAuthentication", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 2660, - "name": "requireCustomerAuthentication", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.RequestHandler" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", - "qualifiedName": "ParamsDictionary" - }, - "name": "ParamsDictionary", - "package": "@types/express-serve-static-core" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", - "qualifiedName": "QueryString.ParsedQs" - }, - "name": "ParsedQs", - "package": "@types/qs", - "qualifiedName": "QueryString.ParsedQs" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "RequestHandler", - "package": "@types/express", - "qualifiedName": "e.RequestHandler" - } - } - ] - }, - { - "id": 428, - "name": "reserveQuantityForDraftOrder", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 429, - "name": "reserveQuantityForDraftOrder", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 430, - "name": "order", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/order.ts", - "qualifiedName": "Order" - }, - "name": "Order", - "package": "@medusajs/medusa" - } - }, - { - "id": 431, - "name": "context", + "id": 4221, + "name": "__namedParameters", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 432, + "id": 4222, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 434, - "name": "locationId", + "id": 4223, + "name": "price", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4224, + "name": "includesTax", "variant": "declaration", "kind": 1024, "flags": { @@ -117857,23 +110821,18 @@ }, "type": { "type": "intrinsic", - "name": "string" + "name": "boolean" } }, { - "id": 433, - "name": "productVariantInventoryService", + "id": 4225, + "name": "taxRate", "variant": "declaration", "kind": 1024, "flags": {}, "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", - "qualifiedName": "ProductVariantInventoryService" - }, - "name": "ProductVariantInventoryService", - "package": "@medusajs/medusa" + "type": "intrinsic", + "name": "number" } } ], @@ -117881,8 +110840,9 @@ { "title": "Properties", "children": [ - 434, - 433 + 4223, + 4224, + 4225 ] } ] @@ -117891,39 +110851,280 @@ } ], "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" + "type": "intrinsic", + "name": "number" } } ] }, { - "id": 4233, + "id": 4226, + "name": "cleanResponseData", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4227, + "name": "cleanResponseData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter response data to contain props specified in the " + }, + { + "kind": "code", + "text": "`allowedProperties`" + }, + { + "kind": "text", + "text": ".\nYou can read more in the transformQuery middleware utility methods." + } + ] + }, + "typeParameter": [ + { + "id": 4228, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "parameters": [ + { + "id": 4229, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "record or an array of records in the response" + } + ] + }, + "type": { + "type": "reference", + "target": 4228, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + }, + { + "id": 4230, + "name": "fields", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "record props allowed in the response" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "conditional", + "checkType": { + "type": "reference", + "target": 4228, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + }, + "extendsType": { + "type": "tuple" + }, + "trueType": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": 4228, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Partial", + "package": "typescript" + } + }, + "falseType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": 4228, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Partial", + "package": "typescript" + } + } + } + ] + }, + { + "id": 4231, + "name": "csvCellContentFormatter", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4232, + "name": "csvCellContentFormatter", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4233, + "name": "str", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 4234, + "name": "csvRevertCellContentFormatter", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4235, + "name": "csvRevertCellContentFormatter", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4236, + "name": "str", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 4237, + "name": "resolveDbType", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4238, + "name": "resolveDbType", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4239, + "name": "pgSqlType", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/ColumnTypes.d.ts", + "qualifiedName": "ColumnType" + }, + "name": "ColumnType", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/ColumnTypes.d.ts", + "qualifiedName": "ColumnType" + }, + "name": "ColumnType", + "package": "typeorm" + } + } + ] + }, + { + "id": 4240, "name": "resolveDbGenerationStrategy", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { - "id": 4234, + "id": 4241, "name": "resolveDbGenerationStrategy", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4235, + "id": 4242, "name": "pgSqlType", "variant": "param", "kind": 32768, @@ -117968,32 +111169,32 @@ ] }, { - "id": 4230, - "name": "resolveDbType", + "id": 4243, + "name": "DbAwareColumn", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { - "id": 4231, - "name": "resolveDbType", + "id": 4244, + "name": "DbAwareColumn", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4232, - "name": "pgSqlType", + "id": 4245, + "name": "columnOptions", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/ColumnTypes.d.ts", - "qualifiedName": "ColumnType" + "sourceFileName": "../../../node_modules/typeorm/decorator/options/ColumnOptions.d.ts", + "qualifiedName": "ColumnOptions" }, - "name": "ColumnType", + "name": "ColumnOptions", "package": "typeorm" } } @@ -118001,31 +111202,755 @@ "type": { "type": "reference", "target": { - "sourceFileName": "../../../node_modules/typeorm/driver/types/ColumnTypes.d.ts", - "qualifiedName": "ColumnType" + "sourceFileName": "../../node_modules/typescript/lib/lib.decorators.legacy.d.ts", + "qualifiedName": "PropertyDecorator" }, - "name": "ColumnType", - "package": "typeorm" + "name": "PropertyDecorator", + "package": "typescript" } } ] }, { - "id": 4288, + "id": 4246, + "name": "PostgresError", + "variant": "declaration", + "kind": 8, + "flags": {}, + "children": [ + { + "id": 4247, + "name": "DUPLICATE_ERROR", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "23505" + } + }, + { + "id": 4248, + "name": "FOREIGN_KEY_ERROR", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "23503" + } + }, + { + "id": 4249, + "name": "SERIALIZATION_FAILURE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "40001" + } + }, + { + "id": 4250, + "name": "NULL_VIOLATION", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "23502" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 4247, + 4248, + 4249, + 4250 + ] + } + ] + }, + { + "id": 4251, + "name": "formatException", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4252, + "name": "formatException", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4253, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "target": 4819, + "name": "MedusaError", + "package": "medusa-core-utils" + } + } + ] + }, + { + "id": 4254, + "name": "generateEntityId", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4255, + "name": "generateEntityId", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Generate a composed id based on the input parameters and return either the is if it exists or the generated one." + } + ] + }, + "parameters": [ + { + "id": 4256, + "name": "idProperty", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4257, + "name": "prefix", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 4258, + "name": "hasChanges", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4259, + "name": "hasChanges", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Compare two objects and return true if there is changes detected from obj2 compared to obj1" + } + ] + }, + "typeParameter": [ + { + "id": 4260, + "name": "T1", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Object" + }, + "name": "Object", + "package": "typescript" + } + }, + { + "id": 4261, + "name": "T2", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Object" + }, + "name": "Object", + "package": "typescript" + } + } + ], + "parameters": [ + { + "id": 4262, + "name": "obj1", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4260, + "name": "T1", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + }, + { + "id": 4263, + "name": "obj2", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4261, + "name": "T2", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 4264, + "name": "isDate", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4265, + "name": "isDate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4266, + "name": "value", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "predicate", + "name": "value", + "asserts": false, + "targetType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + } + } + ] + }, + { + "id": 4267, + "name": "isObject", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4268, + "name": "isObject", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4269, + "name": "obj", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "predicate", + "name": "obj", + "asserts": false, + "targetType": { + "type": "intrinsic", + "name": "object" + } + } + } + ] + }, + { + "id": 4270, + "name": "isString", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4271, + "name": "isString", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4272, + "name": "val", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "predicate", + "name": "val", + "asserts": false, + "targetType": { + "type": "intrinsic", + "name": "string" + } + } + } + ] + }, + { + "id": 4273, + "name": "omitDeep", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4274, + "name": "omitDeep", + "variant": "signature", + "kind": 4096, + "flags": {}, + "typeParameter": [ + { + "id": 4275, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "object" + }, + "default": { + "type": "intrinsic", + "name": "object" + } + } + ], + "parameters": [ + { + "id": 4276, + "name": "input", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 4277, + "name": "excludes", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": 4275, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ] + }, + { + "id": 4278, + "name": "categoryMatchesScope", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4279, + "name": "categoryMatchesScope", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4280, + "name": "category", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A product category can be used to categorize products into a hierarchy of categories." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + }, + { + "id": 4281, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ] + }, + { + "id": 4282, + "name": "fetchCategoryDescendantsIds", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4283, + "name": "fetchCategoryDescendantsIds", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4284, + "name": "productCategory", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A product category can be used to categorize products into a hierarchy of categories." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + }, + { + "id": 4285, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/product-category.ts", + "qualifiedName": "ProductCategory" + }, + "name": "ProductCategory", + "package": "@medusajs/medusa" + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ] + }, + { + "id": 4286, + "name": "getVariantsFromPriceList", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4287, + "name": "getVariantsFromPriceList", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4288, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 4289, + "name": "priceListId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 4969, + "name": "ProductVariantDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 4290, + "name": "listProducts", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4291, + "name": "listProducts", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4292, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 4293, + "name": "filterableFields", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4294, + "name": "listConfig", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 4295, "name": "retrieveProduct", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { - "id": 4289, + "id": 4296, "name": "retrieveProduct", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4290, + "id": 4297, "name": "container", "variant": "param", "kind": 32768, @@ -118036,7 +111961,7 @@ } }, { - "id": 4291, + "id": 4298, "name": "id", "variant": "param", "kind": 32768, @@ -118047,7 +111972,7 @@ } }, { - "id": 4292, + "id": 4299, "name": "remoteQueryObject", "variant": "param", "kind": 32768, @@ -118055,7 +111980,7 @@ "type": { "type": "reflection", "declaration": { - "id": 4293, + "id": 4300, "name": "__type", "variant": "declaration", "kind": 65536, @@ -118084,14 +112009,177 @@ ] }, { - "id": 4307, + "id": 4301, + "name": "remoteQueryFetchData", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4302, + "name": "remoteQueryFetchData", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4303, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4868, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 4304, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4305, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4306, + "name": "expand", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4307, + "name": "keyField", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4308, + "name": "ids", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 4309, + "name": "relationship", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ] + }, + { + "id": 4310, + "name": "removeUndefinedProperties", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4311, + "name": "removeUndefinedProperties", + "variant": "signature", + "kind": 4096, + "flags": {}, + "typeParameter": [ + { + "id": 4312, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "object" + } + } + ], + "parameters": [ + { + "id": 4313, + "name": "inputObj", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4312, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": 4312, + "name": "T", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ] + }, + { + "id": 4314, "name": "setMetadata", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { - "id": 4308, + "id": 4315, "name": "setMetadata", "variant": "signature", "kind": 4096, @@ -118117,7 +112205,7 @@ }, "parameters": [ { - "id": 4309, + "id": 4316, "name": "obj", "variant": "param", "kind": 32768, @@ -118144,14 +112232,14 @@ { "type": "reflection", "declaration": { - "id": 4310, + "id": 4317, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4311, + "id": 4318, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -118190,7 +112278,7 @@ { "title": "Properties", "children": [ - 4311 + 4318 ] } ] @@ -118200,7 +112288,7 @@ } }, { - "id": 4312, + "id": 4319, "name": "metadata", "variant": "param", "kind": 32768, @@ -118257,1010 +112345,21 @@ ] }, { - "id": 2661, - "name": "transformBody", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 2662, - "name": "transformBody", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 2663, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 2664, - "name": "plainToClass", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3977, - "typeArguments": [ - { - "type": "reference", - "target": 2663, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "ClassConstructor", - "package": "@medusajs/medusa" - } - }, - { - "id": 2665, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/class-validator/types/validation/ValidatorOptions.d.ts", - "qualifiedName": "ValidatorOptions" - }, - "name": "ValidatorOptions", - "package": "class-validator" - }, - "defaultValue": "..." - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2666, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2667, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2668, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Request" - }, - "name": "Request", - "package": "@types/express", - "qualifiedName": "e.Request" - } - }, - { - "id": 2669, - "name": "res", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Response" - }, - "name": "Response", - "package": "@types/express", - "qualifiedName": "e.Response" - } - }, - { - "id": 2670, - "name": "next", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.NextFunction" - }, - "name": "NextFunction", - "package": "@types/express", - "qualifiedName": "e.NextFunction" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ] - }, - { - "id": 2671, - "name": "transformIncludesOptions", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 2672, - "name": "transformIncludesOptions", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Retrieve the includes options from the fields query param.\nIf the include option is present then assigned it to includes on req" - } - ] - }, - "parameters": [ - { - "id": 2673, - "name": "allowedIncludes", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of fields that can be passed and assign to req.includes" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "[]" - }, - { - "id": 2674, - "name": "expectedIncludes", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The list of fields that the consumer can pass to the end point using this middleware. It is a subset of " - }, - { - "kind": "code", - "text": "`allowedIncludes`" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - "defaultValue": "[]" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2675, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2676, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2677, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Request" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", - "qualifiedName": "ParamsDictionary" - }, - "name": "ParamsDictionary", - "package": "@types/express-serve-static-core" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", - "qualifiedName": "QueryString.ParsedQs" - }, - "name": "ParsedQs", - "package": "@types/qs", - "qualifiedName": "QueryString.ParsedQs" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "Request", - "package": "@types/express", - "qualifiedName": "e.Request" - } - }, - { - "id": 2678, - "name": "res", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Response" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "Response", - "package": "@types/express", - "qualifiedName": "e.Response" - } - }, - { - "id": 2679, - "name": "next", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.NextFunction" - }, - "name": "NextFunction", - "package": "@types/express", - "qualifiedName": "e.NextFunction" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - } - ] - }, - { - "id": 2680, - "name": "transformQuery", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 2681, - "name": "transformQuery", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Middleware that transform the query input for the admin end points" - } - ] - }, - "typeParameter": [ - { - "id": 2682, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 3894, - "name": "RequestQueryFields", - "package": "@medusajs/medusa" - } - }, - { - "id": 2683, - "name": "TEntity", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", - "qualifiedName": "BaseEntity" - }, - "name": "BaseEntity", - "package": "@medusajs/medusa" - } - } - ], - "parameters": [ - { - "id": 2684, - "name": "plainToClass", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3977, - "typeArguments": [ - { - "type": "reference", - "target": 2682, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "ClassConstructor", - "package": "@medusajs/medusa" - } - }, - { - "id": 2685, - "name": "queryConfig", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Omit" - }, - "typeArguments": [ - { - "type": "reference", - "target": 3885, - "typeArguments": [ - { - "type": "reference", - "target": 2683, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "QueryConfig", - "package": "@medusajs/medusa" - }, - { - "type": "union", - "types": [ - { - "type": "literal", - "value": "allowedFields" - }, - { - "type": "literal", - "value": "allowedRelations" - } - ] - } - ], - "name": "Omit", - "package": "typescript" - } - }, - { - "id": 2686, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/class-validator/types/validation/ValidatorOptions.d.ts", - "qualifiedName": "ValidatorOptions" - }, - "name": "ValidatorOptions", - "package": "class-validator" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2687, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2688, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2689, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Request" - }, - "name": "Request", - "package": "@types/express", - "qualifiedName": "e.Request" - } - }, - { - "id": 2690, - "name": "res", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Response" - }, - "name": "Response", - "package": "@types/express", - "qualifiedName": "e.Response" - } - }, - { - "id": 2691, - "name": "next", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.NextFunction" - }, - "name": "NextFunction", - "package": "@types/express", - "qualifiedName": "e.NextFunction" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ] - }, - { - "id": 2692, - "name": "transformStoreQuery", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 2693, - "name": "transformStoreQuery", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Middleware that transform the query input for the store endpoints" - } - ] - }, - "typeParameter": [ - { - "id": 2694, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 3894, - "name": "RequestQueryFields", - "package": "@medusajs/medusa" - } - }, - { - "id": 2695, - "name": "TEntity", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/interfaces/models/base-entity.ts", - "qualifiedName": "BaseEntity" - }, - "name": "BaseEntity", - "package": "@medusajs/medusa" - } - } - ], - "parameters": [ - { - "id": 2696, - "name": "plainToClass", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 3977, - "typeArguments": [ - { - "type": "reference", - "target": 2694, - "name": "T", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "ClassConstructor", - "package": "@medusajs/medusa" - } - }, - { - "id": 2697, - "name": "queryConfig", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 3885, - "typeArguments": [ - { - "type": "reference", - "target": 2695, - "name": "TEntity", - "package": "@medusajs/medusa", - "refersToTypeParameter": true - } - ], - "name": "QueryConfig", - "package": "@medusajs/medusa" - } - }, - { - "id": 2698, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/class-validator/types/validation/ValidatorOptions.d.ts", - "qualifiedName": "ValidatorOptions" - }, - "name": "ValidatorOptions", - "package": "class-validator" - }, - "defaultValue": "{}" - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 2699, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 2700, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2701, - "name": "req", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Request" - }, - "name": "Request", - "package": "@types/express", - "qualifiedName": "e.Request" - } - }, - { - "id": 2702, - "name": "res", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.Response" - }, - "name": "Response", - "package": "@types/express", - "qualifiedName": "e.Response" - } - }, - { - "id": 2703, - "name": "next", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.NextFunction" - }, - "name": "NextFunction", - "package": "@types/express", - "qualifiedName": "e.NextFunction" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ] - }, - { - "id": 605, - "name": "unauthenticatedInviteRoutes", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 606, - "name": "unauthenticatedInviteRoutes", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 607, - "name": "app", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 2025, - "name": "unauthenticatedUserRoutes", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 2026, - "name": "unauthenticatedUserRoutes", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 2027, - "name": "app", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - }, - { - "id": 827, - "name": "updateInventoryAndReservations", - "variant": "declaration", - "kind": 64, - "flags": {}, - "signatures": [ - { - "id": 828, - "name": "updateInventoryAndReservations", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 829, - "name": "fulfillments", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/models/fulfillment.ts", - "qualifiedName": "Fulfillment" - }, - "name": "Fulfillment", - "package": "@medusajs/medusa" - } - } - }, - { - "id": 830, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 831, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 832, - "name": "inventoryService", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/medusa/src/services/product-variant-inventory.ts", - "qualifiedName": "ProductVariantInventoryService" - }, - "name": "ProductVariantInventoryService", - "package": "@medusajs/medusa" - } - }, - { - "id": 833, - "name": "locationId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 832, - 833 - ] - } - ] - } - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 4313, + "id": 4320, "name": "validateId", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { - "id": 4314, + "id": 4321, "name": "validateId", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 4315, + "id": 4322, "name": "rawId", "variant": "param", "kind": 32768, @@ -119271,7 +112370,7 @@ } }, { - "id": 4316, + "id": 4323, "name": "config", "variant": "param", "kind": 32768, @@ -119279,27 +112378,14 @@ "type": { "type": "reflection", "declaration": { - "id": 4317, + "id": 4324, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 4319, - "name": "length", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 4318, + "id": 4325, "name": "prefix", "variant": "declaration", "kind": 1024, @@ -119310,14 +112396,27 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 4326, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } } ], "groups": [ { "title": "Properties", "children": [ - 4319, - 4318 + 4325, + 4326 ] } ] @@ -119334,28 +112433,88 @@ ] }, { - "id": 4187, + "id": 4191, + "name": "registerOverriddenValidators", + "variant": "declaration", + "kind": 64, + "flags": {}, + "signatures": [ + { + "id": 4192, + "name": "registerOverriddenValidators", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When overriding a validator, you can register it to be used instead of the original one.\nFor example, the place where you are overriding the core validator, you can call this function" + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// /src/api/routes/admin/products/create-product.ts\nimport { registerOverriddenValidators } from \"@medusajs/medusa\"\nimport { AdminPostProductsReq as MedusaAdminPostProductsReq } from \"@medusajs/medusa/dist/api/routes/admin/products/create-product\"\nimport { IsString } from \"class-validator\"\n\nclass AdminPostProductsReq extends MedusaAdminPostProductsReq {\n @IsString()\n test: string\n}\n\nregisterOverriddenValidators(AdminPostProductsReq)\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 4193, + "name": "extendedValidator", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 4964, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Constructor", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + }, + { + "id": 4194, "name": "validator", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { - "id": 4188, + "id": 4195, "name": "validator", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 4189, + "id": 4196, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 4190, + "id": 4197, "name": "V", "variant": "typeParam", "kind": 131072, @@ -119364,7 +112523,7 @@ ], "parameters": [ { - "id": 4191, + "id": 4198, "name": "typedClass", "variant": "param", "kind": 32768, @@ -119378,7 +112537,7 @@ "typeArguments": [ { "type": "reference", - "target": 4189, + "target": 4196, "name": "T", "package": "@medusajs/medusa", "refersToTypeParameter": true @@ -119389,21 +112548,21 @@ } }, { - "id": 4192, + "id": 4199, "name": "plain", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 4190, + "target": 4197, "name": "V", "package": "@medusajs/medusa", "refersToTypeParameter": true } }, { - "id": 4193, + "id": 4200, "name": "config", "variant": "param", "kind": 32768, @@ -119429,7 +112588,7 @@ "typeArguments": [ { "type": "reference", - "target": 4189, + "target": 4196, "name": "T", "package": "@medusajs/medusa", "refersToTypeParameter": true @@ -119442,86 +112601,3997 @@ ] }, { - "id": 2634, - "name": "wrapHandler", + "id": 4327, + "name": "IsType", "variant": "declaration", "kind": 64, "flags": {}, "signatures": [ { - "id": 2635, - "name": "wrapHandler", + "id": 4328, + "name": "IsType", "variant": "signature", "kind": 4096, "flags": {}, + "parameters": [ + { + "id": 4329, + "name": "types", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + } + }, + { + "id": 4330, + "name": "validationOptions", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/class-validator/types/decorator/ValidationOptions.d.ts", + "qualifiedName": "ValidationOptions" + }, + "name": "ValidationOptions", + "package": "class-validator" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 4331, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 4332, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4333, + "name": "object", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Object" + }, + "name": "Object", + "package": "typescript" + } + }, + { + "id": 4334, + "name": "propertyName", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + } + ] + }, + { + "id": 4425, + "name": "PaginatedResponse", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 4426, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4427, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of notifications per page" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4428, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of notifications skipped when retrieving the notifications." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4429, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The total number of notifications" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4427, + 4428, + 4429 + ] + } + ] + } + } + }, + { + "id": 4730, + "name": "DeleteResponse", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The fields returned in the response of a DELETE request." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 4731, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4732, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the item that was deleted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4733, + "name": "object", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the item that was deleted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "defaultValue": "stock_location" + }, + { + "id": 4734, + "name": "deleted", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the item was deleted successfully." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "defaultValue": true + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4732, + 4733, + 4734 + ] + } + ] + } + } + }, + { + "id": 5191, + "name": "SessionOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options to pass to " + }, + { + "kind": "code", + "text": "`express-session`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "children": [ + { + "id": 5192, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, "comment": { - "summary": [], + "summary": [ + { + "kind": "text", + "text": "The name of the session ID cookie to set in the response (and read from in the request). The default value is " + }, + { + "kind": "code", + "text": "`connect.sid`" + }, + { + "kind": "text", + "text": ".\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#name) for more details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5193, + "name": "resave", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the session should be saved back to the session store, even if the session was never modified during the request. The default value is " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ".\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#resave) for more details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5194, + "name": "rolling", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the session identifier cookie should be force-set on every response. The default value is " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ".\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#rolling) for more details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5195, + "name": "saveUninitialized", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether a session that is \"uninitialized\" is forced to be saved to the store. The default value is " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ".\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#saveUninitialized) for more details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5196, + "name": "secret", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The secret to sign the session ID cookie. By default, the value of " + }, + { + "kind": "code", + "text": "`cookie_secret`" + }, + { + "kind": "text", + "text": " is used.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#secret) for details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5197, + "name": "ttl", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used when calculating the " + }, + { + "kind": "code", + "text": "`Expires`" + }, + { + "kind": "text", + "text": " " + }, + { + "kind": "code", + "text": "`Set-Cookie`" + }, + { + "kind": "text", + "text": " attribute of cookies. By default, its value is " + }, + { + "kind": "code", + "text": "`10 * 60 * 60 * 1000`" + }, + { + "kind": "text", + "text": ".\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#cookiemaxage) for details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5192, + 5193, + 5194, + 5195, + 5196, + 5197 + ] + } + ] + }, + { + "id": 5198, + "name": "HttpCompressionOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP compression configurations." + } + ] + }, + "children": [ + { + "id": 5199, + "name": "enabled", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether HTTP compression is enabled. By default, it's " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5200, + "name": "level", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The level of zlib compression to apply to responses. A higher level will result in better compression but will take longer to complete.\nA lower level will result in less compression but will be much faster. The default value is " + }, + { + "kind": "code", + "text": "`6`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 5201, + "name": "memLevel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "How much memory should be allocated to the internal compression state. It's an integer in the range of 1 (minimum level) and 9 (maximum level).\nThe default value is " + }, + { + "kind": "code", + "text": "`8`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 5202, + "name": "threshold", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum response body size that compression is applied on. Its value can be the number of bytes or any string accepted by the\n[bytes](https://www.npmjs.com/package/bytes) module. The default value is " + }, + { + "kind": "code", + "text": "`1024`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5199, + 5200, + 5201, + 5202 + ] + } + ] + }, + { + "id": 5087, + "name": "ProjectConfigOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Essential configurations related to the Medusa backend, such as database and CORS configurations." + } + ] + }, + "children": [ + { + "id": 5088, + "name": "store_cors", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n" + }, + { + "kind": "code", + "text": "`store_cors`" + }, + { + "kind": "text", + "text": " is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, " + }, + { + "kind": "code", + "text": "`http://localhost:8000`" + }, + { + "kind": "text", + "text": ". The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, " + }, + { + "kind": "code", + "text": "`.example.com`" + }, + { + "kind": "text", + "text": ". The regex pattern that the backend tests for is " + }, + { + "kind": "code", + "text": "`^([/~@;%#'])(.*?)\\1([gimsuy]*)$`" + }, + { + "kind": "text", + "text": "." + } + ], "blockTags": [ { - "tag": "@deprecated", + "tag": "@example", "content": [ { "kind": "text", - "text": "use " + "text": "Some example values of common use cases:\n\n" }, { "kind": "code", - "text": "`import { wrapHandler } from \"@medusajs/utils\"`" + "text": "```bash\n# Allow different ports locally starting with 800\nSTORE_CORS=/http://localhost:800\\d+$/\n\n# Allow any origin ending with vercel.app. For example, storefront.vercel.app\nSTORE_CORS=/vercel\\.app$/\n\n# Allow all HTTP requests\nSTORE_CORS=/http://.+/\n```" + }, + { + "kind": "text", + "text": "\n\nThen, set the configuration in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ":\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n store_cors: process.env.STORE_CORS,\n // ...\n },\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\nIf you’re adding the value directly within " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ", make sure to add an extra escaping " + }, + { + "kind": "code", + "text": "`/`" + }, + { + "kind": "text", + "text": " for every backslash in the pattern. For example:\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n store_cors: \"/vercel\\\\.app$/\",\n // ...\n },\n // ...\n}\n```" } ] } ] }, - "parameters": [ - { - "id": 2636, - "name": "fn", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 4840, - "name": "handler", - "package": "@medusajs/medusa" + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5089, + "name": "admin_cors", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n" + }, + { + "kind": "code", + "text": "`admin_cors`" + }, + { + "kind": "text", + "text": " is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins.\n\nEvery origin in that list must either be:\n\n1. A URL. For example, " + }, + { + "kind": "code", + "text": "`http://localhost:7001`" + }, + { + "kind": "text", + "text": ". The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, " + }, + { + "kind": "code", + "text": "`.example.com`" + }, + { + "kind": "text", + "text": ". The regex pattern that the backend tests for is " + }, + { + "kind": "code", + "text": "`^([/~@;%#'])(.*?)\\1([gimsuy]*)$`" + }, + { + "kind": "text", + "text": "." } - } - ], + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Some example values of common use cases:\n\n" + }, + { + "kind": "code", + "text": "```bash\n# Allow different ports locally starting with 700\nADMIN_CORS=/http://localhost:700\\d+$/\n\n# Allow any origin ending with vercel.app. For example, admin.vercel.app\nADMIN_CORS=/vercel\\.app$/\n\n# Allow all HTTP requests\nADMIN_CORS=/http://.+/\n```" + }, + { + "kind": "text", + "text": "\n\nThen, set the configuration in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ":\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n admin_cors: process.env.ADMIN_CORS,\n // ...\n },\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\nIf you’re adding the value directly within " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ", make sure to add an extra escaping " + }, + { + "kind": "code", + "text": "`/`" + }, + { + "kind": "text", + "text": " for every backslash in the pattern. For example:\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n admin_cors: \"/http:\\\\/\\\\/localhost:700\\\\d+$/\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5090, + "name": "cookie_secret", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A random string used to create cookie tokens. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is " + }, + { + "kind": "code", + "text": "`supersecret`" + }, + { + "kind": "text", + "text": " However, in production, if this configuration is not set, an error is thrown and\nthe backend crashes." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n cookie_secret: process.env.COOKIE_SECRET ||\n \"supersecret\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5091, + "name": "jwt_secret", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A random string used to create authentication tokens. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is " + }, + { + "kind": "code", + "text": "`supersecret`" + }, + { + "kind": "text", + "text": " However, in production, if this configuration is not set an error, an\nerror is thrown and the backend crashes." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n jwt_secret: process.env.JWT_SECRET ||\n \"supersecret\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5092, + "name": "database_database", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the database to connect to. If specified in " + }, + { + "kind": "code", + "text": "`database_url`" + }, + { + "kind": "text", + "text": ", then it’s not required to include it.\n\nMake sure to create the PostgreSQL database before using it. You can check how to create a database in\n[PostgreSQL's documentation](https://www.postgresql.org/docs/current/sql-createdatabase.html)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_database: process.env.DATABASE_DATABASE ||\n \"medusa-store\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5093, + "name": "database_url", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The connection URL of the database. The format of the connection URL for PostgreSQL is:\n\n" + }, + { + "kind": "code", + "text": "```bash\npostgres://[user][:password]@[host][:port]/[dbname]\n```" + }, + { + "kind": "text", + "text": "\n\nWhere:\n\n- " + }, + { + "kind": "code", + "text": "`[user]`" + }, + { + "kind": "text", + "text": ": (required) your PostgreSQL username. If not specified, the system's username is used by default. The database user that you use must have create privileges. If you're using the " + }, + { + "kind": "code", + "text": "`postgres`" + }, + { + "kind": "text", + "text": " superuser, then it should have these privileges by default. Otherwise, make sure to grant your user create privileges. You can learn how to do that in [PostgreSQL's documentation](https://www.postgresql.org/docs/current/ddl-priv.html).\n- " + }, + { + "kind": "code", + "text": "`[:password]`" + }, + { + "kind": "text", + "text": ": an optional password for the user. When provided, make sure to put " + }, + { + "kind": "code", + "text": "`:`" + }, + { + "kind": "text", + "text": " before the password.\n- " + }, + { + "kind": "code", + "text": "`[host]`" + }, + { + "kind": "text", + "text": ": (required) your PostgreSQL host. When run locally, it should be " + }, + { + "kind": "code", + "text": "`localhost`" + }, + { + "kind": "text", + "text": ".\n- " + }, + { + "kind": "code", + "text": "`[:post]`" + }, + { + "kind": "text", + "text": ": an optional port that the PostgreSQL server is listening on. By default, it's " + }, + { + "kind": "code", + "text": "`5432`" + }, + { + "kind": "text", + "text": ". When provided, make sure to put " + }, + { + "kind": "code", + "text": "`:`" + }, + { + "kind": "text", + "text": " before the port.\n- " + }, + { + "kind": "code", + "text": "`[dbname]`" + }, + { + "kind": "text", + "text": ": (required) the name of the database.\n\nYou can learn more about the connection URL format in [PostgreSQL’s documentation](https://www.postgresql.org/docs/current/libpq-connect.html)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, set the following database URL in your environment variables:\n\n" + }, + { + "kind": "code", + "text": "```bash\nDATABASE_URL=postgres://postgres@localhost/medusa-store\n```" + }, + { + "kind": "text", + "text": "\n\nThen, use the value in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ":\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_url: process.env.DATABASE_URL,\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5094, + "name": "database_schema", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The database schema to connect to. This is not required to provide if you’re using the default schema, which is " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_schema: process.env.DATABASE_SCHEMA ||\n \"custom\",\n // ...\n },\n // ...\n}\n```" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5095, + "name": "database_logging", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This configuration specifies what database messages to log. Its value can be one of the following:\n\n- (default) A boolean value that indicates whether any messages should be logged.\n- The string value " + }, + { + "kind": "code", + "text": "`all`" + }, + { + "kind": "text", + "text": " that indicates all types of messages should be logged.\n- An array of log-level strings to indicate which type of messages to show in the logs. The strings can be " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`schema`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`error`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`warn`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`info`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`log`" + }, + { + "kind": "text", + "text": ", or " + }, + { + "kind": "code", + "text": "`migration`" + }, + { + "kind": "text", + "text": ". Refer to [Typeorm’s documentation](https://typeorm.io/logging#logging-options) for more details on what each of these values means.\n\nIf this configuration isn't set, its default value is " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ", meaning no database messages are logged." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_logging: [\n \"query\", \"error\",\n ],\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, "type": { "type": "reference", "target": { - "sourceFileName": "../../../node_modules/@types/express/index.d.ts", - "qualifiedName": "e.RequestHandler" + "sourceFileName": "../../../node_modules/typeorm/logger/LoggerOptions.d.ts", + "qualifiedName": "LoggerOptions" + }, + "name": "LoggerOptions", + "package": "typeorm" + } + }, + { + "id": 5097, + "name": "database_extra", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object that includes additional configurations to pass to the database connection. You can pass any configuration. One defined configuration to pass is\n" + }, + { + "kind": "code", + "text": "`ssl`" + }, + { + "kind": "text", + "text": " which enables support for TLS/SSL connections.\n\nThis is useful for production databases, which can be supported by setting the " + }, + { + "kind": "code", + "text": "`rejectUnauthorized`" + }, + { + "kind": "text", + "text": " attribute of " + }, + { + "kind": "code", + "text": "`ssl`" + }, + { + "kind": "text", + "text": " object to " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ".\nDuring development, it’s recommended not to pass this option." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_extra:\n process.env.NODE_ENV !== \"development\"\n ? { ssl: { rejectUnauthorized: false } }\n : {},\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 5098, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5099, + "name": "ssl", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure support for TLS/SSL connection" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 5100, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5101, + "name": "rejectUnauthorized", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to fail connection if the server certificate is verified against the list of supplied CAs and the hostname and no match is found." + } + ] + }, + "type": { + "type": "literal", + "value": false + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5101 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5099 + ] + } + ] + } + } + ] + } + }, + { + "id": 5102, + "name": "redis_url", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to specify the URL to connect to Redis. This is only used for scheduled jobs. If you omit this configuration, scheduled jobs won't work.\n\n:::note\n\nYou must first have Redis installed. You can refer to [Redis's installation guide](https://redis.io/docs/getting-started/installation/).\n\n:::\n\nThe Redis connection URL has the following format:\n\n" + }, + { + "kind": "code", + "text": "```bash\nredis[s]://[[username][:password]@][host][:port][/db-number]\n```" + }, + { + "kind": "text", + "text": "\n\nFor a local Redis installation, the connection URL should be " + }, + { + "kind": "code", + "text": "`redis://localhost:6379`" + }, + { + "kind": "text", + "text": " unless you’ve made any changes to the Redis configuration during installation." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n redis_url: process.env.REDIS_URL ||\n \"redis://localhost:6379\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5103, + "name": "redis_prefix", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prefix set on all keys stored in Redis. The default value is " + }, + { + "kind": "code", + "text": "`sess:`" + }, + { + "kind": "text", + "text": ".\n\nIf this configuration option is provided, it is prepended to " + }, + { + "kind": "code", + "text": "`sess:`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n redis_prefix: process.env.REDIS_PREFIX ||\n \"medusa:\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5104, + "name": "redis_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object of options to pass ioredis. You can refer to [ioredis’s RedisOptions documentation](https://redis.github.io/ioredis/index.html#RedisOptions)\nfor the list of available options." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n redis_options: {\n connectionName: process.env.REDIS_CONNECTION_NAME ||\n \"medusa\",\n },\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/ioredis/built/redis/RedisOptions.d.ts", + "qualifiedName": "RedisOptions" + }, + "name": "RedisOptions", + "package": "ioredis" + } + }, + { + "id": 5105, + "name": "session_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object of options to pass to [express-session](https://www.npmjs.com/package/express-session)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n session_options: {\n name: process.env.SESSION_NAME ||\n \"custom\",\n },\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": 5191, + "name": "SessionOptions", + "package": "@medusajs/types" + } + }, + { + "id": 5106, + "name": "http_compression", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there.\nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIts value is an object that has the following properties:\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header " + }, + { + "kind": "code", + "text": "`\"x-no-compression\": true`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n http_compression: {\n enabled: true,\n level: 6,\n memLevel: 8,\n threshold: 1024,\n },\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": 5198, + "name": "HttpCompressionOptions", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5088, + 5089, + 5090, + 5091, + 5092, + 5093, + 5094, + 5095, + 5097, + 5102, + 5103, + 5104, + 5105, + 5106 + ] + } + ] + }, + { + "id": 4943, + "name": "ConfigModule", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The configurations for your Medusa backend are in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": " located in the root of your Medusa project. The configurations include database, modules, and plugin configurations, among other configurations.\n\n" + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": " exports an object having the following properties:\n\n- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "projectConfig", + "target": 4944, + "tsLinkText": "projectConfig" + }, + { + "kind": "text", + "text": ": (required): An object that holds general configurations related to the Medusa backend, such as database or CORS configurations.\n- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "plugins", + "target": 4945, + "tsLinkText": "plugins" + }, + { + "kind": "text", + "text": ": An array of plugin configurations that defines what plugins are installed and optionally specifies each of their configurations.\n- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "modules", + "target": 4949, + "tsLinkText": "modules" + }, + { + "kind": "text", + "text": ": An object that defines what modules are installed and optionally specifies each of their configurations.\n- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "featureFlags", + "target": 4950, + "tsLinkText": "featureFlags" + }, + { + "kind": "text", + "text": ": An object that enables or disables features guarded by a feature flag.\n\nFor example:\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig,\n plugins,\n modules,\n featureFlags,\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---\n\n## Environment Variables\n\nIt's highly recommended to store the values of configurations in environment variables, then reference them within " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ".\n\nDuring development, you can set your environment variables in the " + }, + { + "kind": "code", + "text": "`.env`" + }, + { + "kind": "text", + "text": " file at the root of your Medusa backend project. In production,\nsetting the environment variables depends on the hosting provider.\n\n---" + } + ] + }, + "children": [ + { + "id": 4944, + "name": "projectConfig", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This property holds essential configurations related to the Medusa backend, such as database and CORS configurations." + } + ] + }, + "type": { + "type": "reference", + "target": 5087, + "name": "ProjectConfigOptions", + "package": "@medusajs/types" + } + }, + { + "id": 4945, + "name": "plugins", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "On your Medusa backend, you can use [Plugins](https://docs.medusajs.com/development/plugins/overview) to add custom features or integrate third-party services.\nFor example, installing a plugin to use Stripe as a payment processor.\n\nAside from installing the plugin with NPM, you need to pass the plugin you installed into the " + }, + { + "kind": "code", + "text": "`plugins`" + }, + { + "kind": "text", + "text": " array defined in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ".\n\nThe items in the array can either be:\n\n- A string, which is the name of the plugin to add. You can pass a plugin as a string if it doesn’t require any configurations.\n- An object having the following properties:\n - " + }, + { + "kind": "code", + "text": "`resolve`" + }, + { + "kind": "text", + "text": ": The name of the plugin.\n - " + }, + { + "kind": "code", + "text": "`options`" + }, + { + "kind": "text", + "text": ": An object that includes the plugin’s options. These options vary for each plugin, and you should refer to the plugin’s documentation for available options." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n plugins: [\n `medusa-my-plugin-1`,\n {\n resolve: `medusa-my-plugin`,\n options: {\n apiKey: process.env.MY_API_KEY ||\n `test`,\n },\n },\n // ...\n ],\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 4946, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4947, + "name": "resolve", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4948, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4947, + 4948 + ] + } + ] + } + } + ] + } + } + }, + { + "id": 4949, + "name": "modules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "In Medusa, commerce and core logic are modularized to allow developers to extend or replace certain [modules](https://docs.medusajs.com/development/modules/overview)\nwith custom implementations.\n\nAside from installing the module with NPM, you must add it to the exported object in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ".\n\nThe keys of the " + }, + { + "kind": "code", + "text": "`modules`" + }, + { + "kind": "text", + "text": " configuration object refer to the type of module. Its value can be one of the following:\n\n1. A boolean value indicating whether the module type is enabled;\n2. Or a string value indicating the name of the module to be used for the module type. This can be used if the module does not require any options;\n3. Or an object having the following properties, but typically you would mainly use the " + }, + { + "kind": "code", + "text": "`resolve`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`options`" + }, + { + "kind": "text", + "text": " properties only:\n 1. " + }, + { + "kind": "code", + "text": "`resolve`" + }, + { + "kind": "text", + "text": ": a string indicating the name of the module.\n 2. " + }, + { + "kind": "code", + "text": "`options`" + }, + { + "kind": "text", + "text": ": an object indicating the options to pass to the module. These options vary for each module, and you should refer to the module’s documentation for details on them.\n 3. " + }, + { + "kind": "code", + "text": "`resources`" + }, + { + "kind": "text", + "text": ": a string indicating whether the module shares the dependency container with the Medusa core. Its value can either be " + }, + { + "kind": "code", + "text": "`shared`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`isolated`" + }, + { + "kind": "text", + "text": ". Refer to the [Modules documentation](https://docs.medusajs.com/development/modules/create#module-scope) for more details.\n 4. " + }, + { + "kind": "code", + "text": "`alias`" + }, + { + "kind": "text", + "text": ": a string indicating a unique alias to register the module under. Other modules can’t use the same alias.\n 5. " + }, + { + "kind": "code", + "text": "`main`" + }, + { + "kind": "text", + "text": ": a boolean value indicating whether this module is the main registered module. This is useful when an alias is used." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n modules: {\n eventBus: {\n resolve: \"@medusajs/event-bus-local\",\n },\n cacheService: {\n resolve: \"@medusajs/cache-redis\",\n options: {\n redisUrl: process.env.CACHE_REDIS_URL,\n ttl: 30,\n },\n },\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" }, "typeArguments": [ { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/express-serve-static-core/index.d.ts", - "qualifiedName": "ParamsDictionary" - }, - "name": "ParamsDictionary", - "package": "@types/express-serve-static-core" + "type": "intrinsic", + "name": "string" }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": 5107, + "name": "InternalModuleDeclaration", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 5117, + "name": "ExternalModuleDeclaration", + "package": "@medusajs/types" + } + ] + } + ], + "name": "Partial", + "package": "typescript" + } + ] + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 4950, + "name": "featureFlags", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Some features in the Medusa backend are guarded by a feature flag. This ensures constant shipping of new features while maintaining the engine’s stability.\n\nYou can specify whether a feature should or shouldn’t be used in your backend by enabling its feature flag. Feature flags can be enabled through either environment\nvariables or through this configuration exported in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ".\n\nIf you want to use the environment variables method, learn more about it in the [Feature Flags documentation](https://docs.medusajs.com/development/feature-flags/toggle#method-one-using-environment-variables).\n\nThe " + }, + { + "kind": "code", + "text": "`featureFlags`" + }, + { + "kind": "text", + "text": " configuration is an object. Its properties are the names of the feature flags. Each property’s value is a boolean indicating whether the feature flag is enabled.\n\nYou can find available feature flags and their key name [here](https://github.com/medusajs/medusa/tree/master/packages/medusa/src/loaders/feature-flags)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n featureFlags: {\n product_categories: true,\n // ...\n },\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::note\n\nAfter enabling a feature flag, make sure to [run migrations](https://docs.medusajs.com/development/entities/migrations/overview#migrate-command) as it may require making changes to the database.\n\n:::" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4944, + 4945, + 4949, + 4950 + ] + } + ] + }, + { + "id": 4868, + "name": "MedusaContainer", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Medusa Container extends [Awilix](https://github.com/jeffijoe/awilix) to\nprovide dependency injection functionalities." + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/awilix/lib/container.d.ts", + "qualifiedName": "AwilixContainer" + }, + "name": "AwilixContainer", + "package": "awilix" + }, + { + "type": "reflection", + "declaration": { + "id": 4869, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {} + } + } + ] + } + }, + { + "id": 4766, + "name": "FileServiceUploadResult", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Details of a file upload's result." + } + ] + }, + "children": [ + { + "id": 4767, + "name": "url", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The file's URL." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4768, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The file's key. This key is used in other operations,\nsuch as deleting a file." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4767, + 4768 + ] + } + ] + }, + { + "id": 4860, + "name": "FileServiceGetUploadStreamResult", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The relevant details to upload a file through a stream." + } + ] + }, + "children": [ + { + "id": 4861, + "name": "writeStream", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A [PassThrough](https://nodejs.org/api/stream.html#class-streampassthrough) write stream object to be used to write the file." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/@types/node/stream.d.ts", + "qualifiedName": "internal.PassThrough" + }, + "name": "PassThrough", + "package": "@types/node", + "qualifiedName": "internal.PassThrough" + } + }, + { + "id": 4862, + "name": "promise", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A promise that should resolved when the writing process is done to finish the upload." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ { "type": "intrinsic", "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 4863, + "name": "url", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the file once it’s uploaded." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4864, + "name": "fileKey", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The identifier of the file in the storage. For example, for a local file service, this can be the file's name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4861, + 4862, + 4863, + 4864 + ] + } + ] + }, + { + "id": 4865, + "name": "GetUploadedFileType", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of a file to retrieve." + } + ] + }, + "children": [ + { + "id": 4866, + "name": "fileKey", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The file's key." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4867, + "name": "isPrivate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the file is private." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4866, + 4867 + ] + } + ] + }, + { + "id": 4854, + "name": "DeleteFileType", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to remove." + } + ] + }, + "children": [ + { + "id": 4855, + "name": "fileKey", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The file's key. When uploading a file, the\nreturned key is used here." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4855 + ] + } + ] + }, + { + "id": 4856, + "name": "UploadStreamDescriptorType", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file being uploaded through a stream." + } + ] + }, + "children": [ + { + "id": 4857, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the file." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4858, + "name": "ext", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The extension of the file." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4859, + "name": "isPrivate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the file should be uploaded to a private bucket or location. By convention, the default value of this property is " }, { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4857, + 4858, + 4859 + ] + } + ] + }, + { + "id": 4393, + "name": "InventoryItemDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 4394, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4395, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory item's ID." + } + ] + }, + "type": { "type": "intrinsic", - "name": "any" + "name": "string" + } + }, + { + "id": 4396, + "name": "sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/@types/qs/index.d.ts", - "qualifiedName": "QueryString.ParsedQs" - }, - "name": "ParsedQs", - "package": "@types/qs", - "qualifiedName": "QueryString.ParsedQs" + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Stock Keeping Unit (SKU) code of the Inventory Item." + } + ] }, - { + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4397, + "name": "origin_country", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4398, + "name": "hs_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4399, + "name": "requires_shipping", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the item requires shipping." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4400, + "name": "mid_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "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": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4401, + "name": "material", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "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": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4402, + "name": "weight", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The weight of the Inventory Item. May be used in shipping rate calculations." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4403, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The length of the Inventory Item. May be used in shipping rate calculations." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4404, + "name": "height", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the Inventory Item. May be used in shipping rate calculations." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4405, + "name": "width", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The width of the Inventory Item. May be used in shipping rate calculations." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4406, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Title of the inventory item" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4407, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description of the inventory item" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4408, + "name": "thumbnail", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Thumbnail for the inventory item" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4409, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional key-value map with additional details" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4410, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was created." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 4411, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was updated." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 4412, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4395, + 4396, + 4397, + 4398, + 4399, + 4400, + 4401, + 4402, + 4403, + 4404, + 4405, + 4406, + 4407, + 4408, + 4409, + 4410, + 4411, + 4412 + ] + } + ] + } + } + }, + { + "id": 4696, + "name": "ReservationItemDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Represents a reservation of an inventory item at a stock location" + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 4697, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4698, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the reservation item" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4699, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the location of the reservation" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4700, + "name": "inventory_item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the inventory item the reservation relates to" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4701, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The id of the reservation item" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4702, + "name": "line_item_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4703, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Description of the reservation item" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4704, + "name": "created_by", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "UserId of user who created the reservation item" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4705, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional key-value map with additional details" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4706, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was created." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 4707, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was updated." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 4708, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4698, + 4699, + 4700, + 4701, + 4702, + 4703, + 4704, + 4705, + 4706, + 4707, + 4708 + ] + } + ] + } + } + }, + { + "id": 4413, + "name": "InventoryLevelDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 4414, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4415, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4416, + "name": "inventory_item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4417, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the item location ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4418, + "name": "stocked_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the total stock quantity of an inventory item at the given location ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4419, + "name": "reserved_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the reserved stock quantity of an inventory item at the given location ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4420, + "name": "incoming_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the incoming stock quantity of an inventory item at the given location ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4421, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional key-value map with additional details" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4422, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was created." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 4423, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was updated." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 4424, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4415, + 4416, + 4417, + 4418, + 4419, + 4420, + 4421, + 4422, + 4423, + 4424 + ] + } + ] + } + } + }, + { + "id": 5181, + "name": "JoinerRelationship", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 5182, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5183, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5184, + "name": "foreignKey", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5185, + "name": "primaryKey", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5186, + "name": "serviceName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5187, + "name": "isInternalService", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5188, + "name": "inverse", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "In an inverted relationship the foreign key is on the other service and the primary key is on the current service" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5189, + "name": "isList", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Force the relationship to return a list" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5190, + "name": "args", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Extra arguments to pass to the remoteFetchData callback" + } + ] + }, + "type": { "type": "reference", "target": { "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", @@ -119540,11 +116610,5810 @@ "name": "Record", "package": "typescript" } - ], - "name": "RequestHandler", - "package": "@types/express", - "qualifiedName": "e.RequestHandler" + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5183, + 5184, + 5185, + 5186, + 5187, + 5188, + 5189, + 5190 + ] + } + ] + } + } + }, + { + "id": 5178, + "name": "JoinerServiceConfigAlias", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 5179, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] } + }, + { + "id": 5180, + "name": "args", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Extra arguments to pass to the remoteFetchData callback" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5179, + 5180 + ] + } + ] + }, + { + "id": 5069, + "name": "JoinerServiceConfig", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 5070, + "name": "serviceName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5071, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Property name to use as entrypoint to the service" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 5178, + "name": "JoinerServiceConfigAlias", + "package": "@medusajs/types" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": 5178, + "name": "JoinerServiceConfigAlias", + "package": "@medusajs/types" + } + } + ] + } + }, + { + "id": 5072, + "name": "fieldAlias", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 5073, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5074, + "name": "path", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5075, + "name": "forwardArgumentsOnPath", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5074, + 5075 + ] + } + ] + } + } + ] + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 5076, + "name": "primaryKeys", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 5077, + "name": "relationships", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5181, + "name": "JoinerRelationship", + "package": "@medusajs/types" + } + } + }, + { + "id": 5078, + "name": "extends", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 5079, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5080, + "name": "serviceName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5081, + "name": "relationship", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 5181, + "name": "JoinerRelationship", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5080, + 5081 + ] + } + ] + } + } + } + }, + { + "id": 5082, + "name": "args", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Extra arguments to pass to the remoteFetchData callback" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5070, + 5071, + 5072, + 5076, + 5077, + 5078, + 5082 + ] + } + ] + }, + { + "id": 4964, + "name": "Constructor", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 4968, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 4965, + "name": "__type", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 4966, + "name": "__type", + "variant": "signature", + "kind": 16384, + "flags": {}, + "parameters": [ + { + "id": 4967, + "name": "args", + "variant": "param", + "kind": 32768, + "flags": { + "isRest": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + } + } + ], + "type": { + "type": "reference", + "target": 4968, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + ] + } + } + }, + { + "id": 5203, + "name": "INTERNAL", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "internal" + } + }, + { + "id": 5219, + "name": "EXTERNAL", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "external" + } + }, + { + "id": 5204, + "name": "MODULE_RESOURCE_TYPE", + "variant": "declaration", + "kind": 8, + "flags": {}, + "children": [ + { + "id": 5205, + "name": "SHARED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "shared" + } + }, + { + "id": 5206, + "name": "ISOLATED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "isolated" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 5205, + 5206 + ] + } + ] + }, + { + "id": 5107, + "name": "InternalModuleDeclaration", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 5108, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5109, + "name": "scope", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 5203, + "name": "MODULE_SCOPE.INTERNAL", + "package": "@medusajs/types" + } + }, + { + "id": 5110, + "name": "resources", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 5204, + "name": "MODULE_RESOURCE_TYPE", + "package": "@medusajs/types" + } + }, + { + "id": 5111, + "name": "dependencies", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 5112, + "name": "definition", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 5207, + "name": "ModuleDefinition", + "package": "@medusajs/types" + } + }, + { + "id": 5113, + "name": "resolve", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5114, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 5115, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If multiple modules are registered with the same key, the alias can be used to differentiate them" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5116, + "name": "main", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the module is the main module for the key when multiple ones are registered" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5109, + 5110, + 5111, + 5112, + 5113, + 5114, + 5115, + 5116 + ] + } + ] + } + } + }, + { + "id": 5117, + "name": "ExternalModuleDeclaration", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 5118, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5119, + "name": "scope", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 5219, + "name": "MODULE_SCOPE.EXTERNAL", + "package": "@medusajs/types" + } + }, + { + "id": 5120, + "name": "definition", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 5207, + "name": "ModuleDefinition", + "package": "@medusajs/types" + } + }, + { + "id": 5121, + "name": "server", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 5122, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5123, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "literal", + "value": "http" + } + }, + { + "id": 5124, + "name": "url", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5125, + "name": "keepAlive", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5123, + 5124, + 5125 + ] + } + ] + } + } + }, + { + "id": 5126, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 5127, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If multiple modules are registered with the same key, the alias can be used to differentiate them" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5128, + "name": "main", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the module is the main module for the key when multiple ones are registered" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5119, + 5120, + 5121, + 5126, + 5127, + 5128 + ] + } + ] + } + } + }, + { + "id": 5207, + "name": "ModuleDefinition", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 5208, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5209, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5210, + "name": "registrationName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5211, + "name": "defaultPackage", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": false + } + ] + } + }, + { + "id": 5212, + "name": "label", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5213, + "name": "canOverride", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "property will be removed in future versions" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5214, + "name": "isRequired", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "property will be removed in future versions" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5215, + "name": "isQueryable", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5216, + "name": "isLegacy", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5217, + "name": "dependencies", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 5218, + "name": "defaultModuleDeclaration", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 5107, + "name": "InternalModuleDeclaration", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 5117, + "name": "ExternalModuleDeclaration", + "package": "@medusajs/types" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5209, + 5210, + 5211, + 5212, + 5213, + 5214, + 5215, + 5216, + 5217, + 5218 + ] + } + ] + } + } + }, + { + "id": 5167, + "name": "ModulesResponse", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 5168, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5169, + "name": "module", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5170, + "name": "resolution", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": false + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5169, + 5170 + ] + } + ] + } + } + } + }, + { + "id": 4914, + "name": "ModuleJoinerConfig", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": 5069, + "name": "JoinerServiceConfig", + "package": "@medusajs/types" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "serviceName" + }, + { + "type": "literal", + "value": "primaryKeys" + }, + { + "type": "literal", + "value": "relationships" + }, + { + "type": "literal", + "value": "extends" + } + ] + } + ], + "name": "Omit", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 4915, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4916, + "name": "schema", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "GraphQL schema for the all module's available entities and fields" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4917, + "name": "relationships", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5083, + "name": "ModuleJoinerRelationship", + "package": "@medusajs/types" + } + } + }, + { + "id": 4918, + "name": "extends", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 4919, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4920, + "name": "serviceName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4921, + "name": "fieldAlias", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 4922, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4923, + "name": "path", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4924, + "name": "forwardArgumentsOnPath", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4923, + 4924 + ] + } + ] + } + } + ] + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 4925, + "name": "relationship", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 5083, + "name": "ModuleJoinerRelationship", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4920, + 4921, + 4925 + ] + } + ] + } + } + } + }, + { + "id": 4926, + "name": "serviceName", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4927, + "name": "primaryKeys", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 4928, + "name": "isLink", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the module is a link module" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4929, + "name": "linkableKeys", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Keys that can be used to link to other modules. e.g { product_id: \"Product\" } \"Product\" being the entity it refers to" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 4930, + "name": "isReadOnlyLink", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true it expands a RemoteQuery property but doesn't create a pivot table" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4931, + "name": "databaseConfig", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 4932, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4933, + "name": "tableName", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the pivot table. If not provided it is auto generated" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4934, + "name": "idPrefix", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prefix for the id column. If not provided it is \"link\"" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4935, + "name": "extraFields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 4936, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4937, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "date" + }, + { + "type": "literal", + "value": "time" + }, + { + "type": "literal", + "value": "datetime" + }, + { + "type": "literal", + "value": "bigint" + }, + { + "type": "literal", + "value": "blob" + }, + { + "type": "literal", + "value": "uint8array" + }, + { + "type": "literal", + "value": "array" + }, + { + "type": "literal", + "value": "enumArray" + }, + { + "type": "literal", + "value": "enum" + }, + { + "type": "literal", + "value": "json" + }, + { + "type": "literal", + "value": "integer" + }, + { + "type": "literal", + "value": "smallint" + }, + { + "type": "literal", + "value": "tinyint" + }, + { + "type": "literal", + "value": "mediumint" + }, + { + "type": "literal", + "value": "float" + }, + { + "type": "literal", + "value": "double" + }, + { + "type": "literal", + "value": "boolean" + }, + { + "type": "literal", + "value": "decimal" + }, + { + "type": "literal", + "value": "string" + }, + { + "type": "literal", + "value": "uuid" + }, + { + "type": "literal", + "value": "text" + } + ] + } + }, + { + "id": 4938, + "name": "defaultValue", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4939, + "name": "nullable", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4940, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Mikro-orm options for the column" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4937, + 4938, + 4939, + 4940 + ] + } + ] + } + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4933, + 4934, + 4935 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4916, + 4917, + 4918, + 4926, + 4927, + 4928, + 4929, + 4930, + 4931 + ] + } + ] + } + } + ] + } + }, + { + "id": 5083, + "name": "ModuleJoinerRelationship", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 5181, + "name": "JoinerRelationship", + "package": "@medusajs/types" + }, + { + "type": "reflection", + "declaration": { + "id": 5084, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5085, + "name": "isInternalService", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the relationship is an internal service from the medusa core TODO: Remove when there are no more \"internal\" services" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5086, + "name": "deleteCascade", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the link joiner will cascade deleting the relationship" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5085, + 5086 + ] + } + ] + } + } + ] + } + }, + { + "id": 5228, + "name": "ProductStatus", + "variant": "declaration", + "kind": 8, + "flags": {}, + "children": [ + { + "id": 5229, + "name": "DRAFT", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "draft" + } + }, + { + "id": 5230, + "name": "PROPOSED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "proposed" + } + }, + { + "id": 5231, + "name": "PUBLISHED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "published" + } + }, + { + "id": 5232, + "name": "REJECTED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "rejected" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 5229, + 5230, + 5231, + 5232 + ] + } + ] + }, + { + "id": 5137, + "name": "ProductDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A product's data." + } + ] + }, + "children": [ + { + "id": 5138, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5139, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5140, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The handle of the product. The handle can be used to create slug URL paths." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 5141, + "name": "subtitle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The subttle of the product." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 5142, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the product." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 5143, + "name": "is_giftcard", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the product is a gift card." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5144, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The status of the product." + } + ] + }, + "type": { + "type": "reference", + "target": 5228, + "name": "ProductStatus", + "package": "@medusajs/types" + } + }, + { + "id": 5145, + "name": "thumbnail", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the product's thumbnail." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 5146, + "name": "width", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The width of the product." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 5147, + "name": "weight", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The weight of the product." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 5148, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The length of the product." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 5149, + "name": "height", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the product." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 5150, + "name": "origin_country", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The origin country of the product." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 5151, + "name": "hs_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HS Code of the product." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 5152, + "name": "mid_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The MID Code of the product." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 5153, + "name": "material", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The material of the product." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 5154, + "name": "collection", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product collection." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 5233, + "name": "ProductCollectionDTO", + "package": "@medusajs/types" + } + }, + { + "id": 5155, + "name": "categories", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product categories." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": 5240, + "name": "ProductCategoryDTO", + "package": "@medusajs/types" + } + } + ] + } + }, + { + "id": 5156, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product type." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5252, + "name": "ProductTypeDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 5157, + "name": "tags", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product tags." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5257, + "name": "ProductTagDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 5158, + "name": "variants", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product variants." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 4969, + "name": "ProductVariantDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 5159, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product options." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5221, + "name": "ProductOptionDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 5160, + "name": "images", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product images." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5262, + "name": "ProductImageDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 5161, + "name": "discountable", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the product can be discounted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5162, + "name": "external_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain\na reference to the ID in the integrated service." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 5163, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product was created." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 5164, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product was updated." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 5165, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 5166, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds custom data in key-value pairs." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5138, + 5139, + 5140, + 5141, + 5142, + 5143, + 5144, + 5145, + 5146, + 5147, + 5148, + 5149, + 5150, + 5151, + 5152, + 5153, + 5154, + 5155, + 5156, + 5157, + 5158, + 5159, + 5160, + 5161, + 5162, + 5163, + 5164, + 5165, + 5166 + ] + } + ] + }, + { + "id": 4969, + "name": "ProductVariantDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A product variant's data." + } + ] + }, + "children": [ + { + "id": 4970, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4971, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tile of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4972, + "name": "sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The SKU of the product variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 4973, + "name": "barcode", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The barcode of the product variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 4974, + "name": "ean", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The EAN of the product variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 4975, + "name": "upc", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The UPC of the product variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 4976, + "name": "inventory_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The inventory quantiy of the product variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4977, + "name": "allow_backorder", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the product variant can be ordered when it's out of stock." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4978, + "name": "manage_inventory", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the product variant's inventory should be managed by the core system." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 4979, + "name": "hs_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The HS Code of the product variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 4980, + "name": "origin_country", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The origin country of the product variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 4981, + "name": "mid_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The MID Code of the product variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 4982, + "name": "material", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The material of the product variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 4983, + "name": "weight", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The weight of the product variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 4984, + "name": "length", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The length of the product variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 4985, + "name": "height", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The height of the product variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 4986, + "name": "width", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The width of the product variant." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 4987, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product options." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5130, + "name": "ProductOptionValueDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 4988, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds custom data in key-value pairs." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + }, + { + "id": 4989, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 5137, + "name": "ProductDTO", + "package": "@medusajs/types" + } + }, + { + "id": 4990, + "name": "product_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated product." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4991, + "name": "variant_rank", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "he ranking of the variant among other variants associated with the product." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 4992, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product variant was created." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 4993, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product variant was updated." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 4994, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product variant was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4970, + 4971, + 4972, + 4973, + 4974, + 4975, + 4976, + 4977, + 4978, + 4979, + 4980, + 4981, + 4982, + 4983, + 4984, + 4985, + 4986, + 4987, + 4988, + 4989, + 4990, + 4991, + 4992, + 4993, + 4994 + ] + } + ] + }, + { + "id": 5240, + "name": "ProductCategoryDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A product category's data." + } + ] + }, + "children": [ + { + "id": 5241, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product category." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5242, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the product category." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5243, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the product category." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5244, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The handle of the product category. The handle can be used to create slug URL paths." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5245, + "name": "is_active", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the product category is active." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5246, + "name": "is_internal", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the product category is internal. This can be used to only show the product category to admins and hide it from customers." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 5247, + "name": "rank", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ranking of the product category among sibling categories." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 5248, + "name": "parent_category", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated parent category." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 5240, + "name": "ProductCategoryDTO", + "package": "@medusajs/types" + } + }, + { + "id": 5249, + "name": "category_children", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated child categories." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5240, + "name": "ProductCategoryDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 5250, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product category was created." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 5251, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product category was updated." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5241, + 5242, + 5243, + 5244, + 5245, + 5246, + 5247, + 5248, + 5249, + 5250, + 5251 + ] + } + ] + }, + { + "id": 5257, + "name": "ProductTagDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A product tag's data." + } + ] + }, + "children": [ + { + "id": 5258, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product tag." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5259, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the product tag." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5260, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds custom data in key-value pairs." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + }, + { + "id": 5261, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated products." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5137, + "name": "ProductDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5258, + 5259, + 5260, + 5261 + ] + } + ] + }, + { + "id": 5233, + "name": "ProductCollectionDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A product collection's data." + } + ] + }, + "children": [ + { + "id": 5234, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product collection." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5235, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the product collection." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5236, + "name": "handle", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The handle of the product collection. The handle can be used to create slug URL paths." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5237, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds custom data in key-value pairs." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + }, + { + "id": 5238, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product collection was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 5239, + "name": "products", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated products." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5137, + "name": "ProductDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5234, + 5235, + 5236, + 5237, + 5238, + 5239 + ] + } + ] + }, + { + "id": 5252, + "name": "ProductTypeDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A product type's data." + } + ] + }, + "children": [ + { + "id": 5253, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product type." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5254, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the product type." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5255, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds custom data in key-value pairs." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + }, + { + "id": 5256, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product type was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5253, + 5254, + 5255, + 5256 + ] + } + ] + }, + { + "id": 5221, + "name": "ProductOptionDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A product option's data." + } + ] + }, + "children": [ + { + "id": 5222, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5223, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the product option." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5224, + "name": "product", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 5137, + "name": "ProductDTO", + "package": "@medusajs/types" + } + }, + { + "id": 5225, + "name": "values", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product option values." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5130, + "name": "ProductOptionValueDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 5226, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds custom data in key-value pairs." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + }, + { + "id": 5227, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product option was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5222, + 5223, + 5224, + 5225, + 5226, + 5227 + ] + } + ] + }, + { + "id": 5262, + "name": "ProductImageDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product image's data." + } + ] + }, + "children": [ + { + "id": 5263, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product image." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5264, + "name": "url", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the product image." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5265, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds custom data in key-value pairs." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + }, + { + "id": 5266, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product image was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5263, + 5264, + 5265, + 5266 + ] + } + ] + }, + { + "id": 5130, + "name": "ProductOptionValueDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product option value's data." + } + ] + }, + "children": [ + { + "id": 5131, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the product option value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5132, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the product option value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5133, + "name": "option", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product option. It may only be available if the " + }, + { + "kind": "code", + "text": "`option`" + }, + { + "kind": "text", + "text": " relation is expanded." + } + ] + }, + "type": { + "type": "reference", + "target": 5221, + "name": "ProductOptionDTO", + "package": "@medusajs/types" + } + }, + { + "id": 5134, + "name": "variant", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated product variant. It may only be available if the " + }, + { + "kind": "code", + "text": "`variant`" + }, + { + "kind": "text", + "text": " relation is expanded." + } + ] + }, + "type": { + "type": "reference", + "target": 4969, + "name": "ProductVariantDTO", + "package": "@medusajs/types" + } + }, + { + "id": 5135, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds custom data in key-value pairs." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + }, + { + "id": 5136, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the product option value was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5131, + 5132, + 5133, + 5134, + 5135, + 5136 + ] + } + ] + }, + { + "id": 5014, + "name": "StockLocationAddressDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Represents a Stock Location Address" + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 5015, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 5016, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The stock location address' ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5017, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5018, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' complement" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5019, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location company' name" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5020, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' country" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5021, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' city" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5022, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' phone number" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5023, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' postal code" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5024, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' province" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5025, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional key-value map with additional details" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 5026, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was created." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 5027, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was updated." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 5028, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 5016, + 5017, + 5018, + 5019, + 5020, + 5021, + 5022, + 5023, + 5024, + 5025, + 5026, + 5027, + 5028 + ] + } + ] + } + } + }, + { + "id": 4720, + "name": "StockLocationDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Represents a Stock Location" + } + ], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 4721, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4722, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The stock location's ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4723, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the stock location" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4724, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An optional key-value map with additional details" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 4725, + "name": "address_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Stock location address' ID" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4726, + "name": "address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Address of the Stock Location" + } + ] + }, + "type": { + "type": "reference", + "target": 5014, + "name": "StockLocationAddressDTO", + "package": "@medusajs/types" + } + }, + { + "id": 4727, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was created." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 4728, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was updated." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 4729, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The date with timezone at which the resource was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4722, + 4723, + 4724, + 4725, + 4726, + 4727, + 4728, + 4729 + ] + } + ] + } + } + }, + { + "id": 4735, + "name": "StockLocationExpandedDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [], + "modifierTags": [ + "@interface" + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 4720, + "name": "StockLocationDTO", + "package": "@medusajs/types" + }, + { + "type": "reflection", + "declaration": { + "id": 4736, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4737, + "name": "sales_channels", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated sales channels." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4737 + ] + } + ] + } + } + ] + } + }, + { + "id": 4895, + "name": "ITransactionBaseService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 4896, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 4897, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 4898, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 4896 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 3553, + "name": "IPriceSelectionStrategy" + } + ] + }, + { + "id": 4543, + "name": "PriceListStatus", + "variant": "declaration", + "kind": 8, + "flags": {}, + "children": [ + { + "id": 4544, + "name": "ACTIVE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "active" + } + }, + { + "id": 4545, + "name": "DRAFT", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "draft" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 4544, + 4545 + ] + } + ] + }, + { + "id": 4546, + "name": "PriceListType", + "variant": "declaration", + "kind": 8, + "flags": {}, + "children": [ + { + "id": 4547, + "name": "SALE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "sale" + } + }, + { + "id": 4548, + "name": "OVERRIDE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "override" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 4547, + 4548 + ] } ] } @@ -119553,845 +122422,845 @@ { "title": "Namespaces", "children": [ - 4905 + 4894 ] }, { "title": "Enumerations", "children": [ - 3798, - 4916, - 5219, - 4239, - 4064, - 4536, - 4061, - 4539, - 5243 + 4905, + 3805, + 4068, + 4071, + 4246, + 5204, + 5228, + 4543, + 4546 ] }, { "title": "Enumeration Members", "children": [ - 4915, - 5234, - 5218 + 4904, + 5203, + 5219 ] }, { "title": "Classes", "children": [ - 2748, - 2824, - 2920, - 3056, - 3186, - 3300, - 3456, - 3561, - 3643, - 3711, - 4437, - 4466, - 4808, - 3949, - 3935, - 264, - 2050, - 150, - 375, - 380, - 284, - 1099, - 1103, - 1231, - 1227, - 105, - 1515, - 1714, - 1744, - 1925, - 1921, - 1934, - 1930, - 1943, - 1939, - 2017, + 4819, + 5, + 10, + 21, + 33, 39, 47, + 78, + 82, 88, 93, + 105, + 109, 121, + 129, + 141, + 145, + 150, 154, 159, + 172, + 184, 193, - 294, - 299, + 4354, + 202, + 364, + 370, + 229, + 238, + 243, + 256, + 264, + 273, + 278, + 284, + 375, + 380, 289, - 4359, + 299, + 294, 304, + 316, + 324, + 329, + 341, + 349, + 359, + 400, + 4383, + 4379, + 4371, + 414, 422, + 435, + 4389, + 446, + 462, 470, - 568, + 476, + 509, + 526, + 531, + 537, 542, 547, + 568, + 574, + 590, + 595, + 600, + 612, + 618, + 623, + 635, 641, + 647, 659, + 671, + 687, + 693, + 699, + 704, + 714, + 722, + 718, + 737, + 743, + 748, + 753, + 769, + 774, + 764, + 779, + 784, + 789, + 794, + 817, + 822, + 799, + 4439, + 4449, + 4430, + 4444, + 812, + 834, + 4456, + 841, + 846, + 852, + 873, + 879, + 857, + 4461, + 4468, + 4478, + 4473, + 868, + 884, + 890, + 895, + 901, 906, 911, + 934, + 939, + 946, + 951, + 4509, + 961, + 966, + 4523, + 4514, + 4995, + 5000, + 973, + 978, + 4530, + 4535, + 991, 1006, - 1129, + 1011, + 1023, + 1028, + 1082, + 4549, + 1087, + 1099, + 1103, 1107, - 1173, + 1129, + 4553, + 1146, + 1218, + 1222, + 1187, + 1197, + 1227, + 1231, 1168, - 1402, + 1173, + 1202, + 1213, 1241, 1246, 1263, + 1348, + 5005, + 4590, + 4594, + 1352, + 4624, + 1380, + 1402, 1407, 1433, - 1578, - 1550, - 1674, - 1641, - 1718, - 1771, - 1831, - 1836, - 1891, - 1905, - 1916, - 2089, - 2074, - 4341, - 4476, - 10, - 5, - 21, - 33, - 109, - 82, - 129, - 141, - 172, - 145, - 202, - 184, - 229, - 316, - 370, - 364, - 324, - 238, - 278, - 359, - 329, - 256, - 273, - 243, - 446, - 414, - 435, - 400, - 476, - 462, - 590, - 574, - 600, - 595, - 537, - 531, - 526, - 509, - 618, - 612, - 623, - 647, - 635, - 671, - 722, - 687, - 718, - 693, - 714, - 753, - 769, - 748, - 779, - 789, - 890, - 884, - 973, - 966, - 822, - 817, - 812, - 799, - 794, - 764, - 841, - 834, - 991, - 946, - 939, - 978, - 961, - 951, - 852, - 846, - 743, - 737, - 774, - 868, - 857, - 901, - 895, - 934, - 879, - 873, - 784, - 1028, - 1082, - 1146, - 1087, - 1213, - 1222, - 1218, - 1202, - 1197, - 1187, 1440, 1445, - 1348, + 5009, + 4650, 1449, - 1380, + 4682, 1475, - 1352, - 78, 1507, - 1532, 1511, + 1515, + 1519, + 1523, + 1532, 1554, 1558, 1562, - 1589, 1566, + 1545, + 1550, + 1578, + 1589, 1665, + 1674, 1689, - 1621, 1613, + 1621, + 1641, + 4691, 1646, 1704, 1740, 1708, + 1714, + 1718, + 1744, 1734, - 1777, + 4709, 1756, - 1802, + 1771, + 4714, + 1777, 1796, - 1855, - 1848, - 1826, + 1802, + 4738, 1819, + 1826, + 1831, + 1836, + 4749, + 1848, + 1855, 1873, - 1985, - 1975, - 2000, - 1952, + 1891, 1948, - 1961, + 1952, 1957, - 1990, - 1970, + 1961, 1966, - 2021, - 4090, - 4080, - 4764, - 4550, - 2040, - 2046, - 341, - 1011, - 2058, - 349, - 4351, - 4471, - 4542, - 4546, - 4328, - 3911, - 4372, - 4382, - 4777, - 3908, - 3823, - 4332, - 4067, - 4622, - 3968, - 3963, - 1545, - 699, - 704, - 1023, - 1519, - 1523, - 4773, - 4347, + 1970, + 1975, + 1985, + 1916, + 1905, + 1921, + 1925, + 1930, + 1934, + 1939, + 1943, + 1990, + 2000, 2012, - 5007, + 2017, + 2021, + 2050, + 2046, + 2040, + 2058, + 2089, + 2074, + 2121, + 2141, 2146, - 4364, - 4423, - 4449, - 4507, - 4684, - 4789, - 4801, - 4813, - 3928, - 4702, - 4707, - 4495, - 4523, - 4781, - 4558, - 4680, - 4583, - 4579, - 4575, - 4570, - 4565, - 4617, - 4675, - 5017, - 5021, - 4609, - 4666, - 4587, - 4643, - 4454, - 4432, - 4461, - 4502, - 4796, - 2325, - 4376, - 4442, - 4516, - 4528, - 4731, - 4742, + 2151, + 2159, + 2165, + 4779, + 4783, + 2169, + 2182, + 2187, 2199, + 2226, + 2230, 2238, 2245, + 2272, + 2266, + 2276, + 2290, + 2310, + 2321, + 2325, 2329, + 2337, + 2348, 2352, + 2357, + 2363, + 2367, 2384, 2389, 2407, 2425, 2483, 2494, - 2539, - 2534, - 2572, - 2607, - 2598, - 2367, - 2121, - 2151, - 2182, - 2159, - 2165, - 2187, - 2169, - 2141, - 2321, - 2276, - 2226, - 2337, - 2272, - 2290, - 2230, - 2266, - 2310, - 2348, - 2363, - 2357, - 2560, 2519, + 2534, + 2539, + 4802, + 4795, + 2560, + 2572, + 4807, + 4814, 2583, + 2598, + 2607, + 2748, + 2824, + 2920, + 3057, + 3191, + 3306, + 3462, + 3567, + 3648, + 3717, + 3767, + 3830, + 3915, 3918, - 5012, - 3760 + 3925, + 3935, + 3942, + 3956, + 3970, + 3975, + 4339, + 4335, + 4348, + 4366, + 4358, + 4483, + 4502, + 4074, + 4087, + 4097, + 4787, + 4770, + 4557, + 4565, + 4673, + 4616, + 4629, + 4582, + 4586, + 4577, + 4572, + 4687 ] }, { "title": "Interfaces", "children": [ - 3877, - 3904, - 3847, - 2979, 2704, 2818, 2870, - 3144, - 3547, - 3637, - 3705, - 4906, - 5081, + 2980, + 3145, + 3149, + 3249, + 3258, + 3263, + 3267, + 3380, + 3553, + 3620, + 3635, + 3642, + 3711, + 3854, + 3884, + 3901, + 3907, + 3911, + 4149, + 4962, 5191, - 4142, - 3900, - 3261, - 3243, - 3257, - 3252, - 3374, - 5255, - 5248, - 5150, - 5277, - 5236, - 5143, - 5272, - 5267, - 4981, - 3894, - 4974 + 5198, + 5087, + 4943, + 4766, + 4860, + 4865, + 4854, + 4856, + 5178, + 5069, + 5137, + 4969, + 5240, + 5257, + 5233, + 5252, + 5221, + 5262, + 5130, + 4895 ] }, { "title": "Type Aliases", "children": [ - 4, + 4883, + 4846, 1, + 4, 15, - 29, - 26, 18, - 69, + 26, + 29, 66, + 69, + 70, 75, 115, 118, + 133, 136, 137, - 133, - 180, 177, - 70, - 1789, - 2008, - 2034, - 223, + 180, + 216, 219, 222, + 223, 226, - 216, + 390, + 393, 396, 397, - 393, - 1861, - 2109, + 455, 458, 459, - 455, + 487, 490, 491, + 494, 500, 503, - 487, 608, 609, + 628, 631, 632, - 628, 653, 656, + 675, + 678, 681, 682, - 678, - 675, - 729, 726, - 1001, + 729, 998, - 1870, + 1001, 1017, - 390, + 1020, + 1065, 1068, 1073, - 1075, 1074, - 1065, + 1075, 1076, 1079, - 1164, 1161, + 1164, 1165, 1238, 1260, 1314, - 1326, 1320, + 1326, 1331, - 1340, - 1337, 1334, + 1337, + 1340, 1345, - 1503, - 1500, - 1504, 1497, - 1020, - 1544, - 1541, + 1500, + 1503, + 1504, 1538, - 1664, - 1659, + 1541, + 1544, 1652, - 1612, - 1609, + 1655, + 1659, + 1664, 1606, + 1609, + 1612, 1632, 1635, 1638, - 1700, - 1699, - 1701, 1696, - 1755, + 1699, + 1700, + 1701, 1749, 1752, - 1793, + 1755, + 1789, 1790, + 1793, 1812, - 1816, 1813, + 1816, + 1861, 1864, + 1867, + 1870, 1885, 1888, - 1867, 1898, 1899, 1902, - 2009, 2005, + 2008, + 2009, 2028, 2031, + 2034, + 2035, + 2094, + 2097, + 2100, + 2109, 2068, 2071, - 3832, - 3812, - 3818, - 3806, - 2814, - 3977, - 4046, - 4954, - 4041, - 4976, - 3807, - 4099, - 4877, - 3350, - 494, - 4848, - 4723, - 5063, - 3857, - 3973, - 1655, - 4753, - 5130, - 5041, - 4860, - 4759, - 4875, - 4868, - 5059, - 5212, - 4952, - 5120, - 4386, - 4406, - 3693, - 5194, - 2094, - 4917, - 3983, - 3982, - 4878, - 4894, - 4967, - 4154, - 4155, - 4153, - 4047, - 4051, - 4963, - 4057, - 5222, - 4925, - 5095, - 5045, - 5180, - 4418, - 4964, - 3842, - 3353, - 3351, - 3352, - 3368, - 4135, - 4127, - 4118, - 3613, - 3629, - 3628, - 4562, - 4800, - 4763, - 5046, - 5099, - 5067, - 5074, - 4924, - 3885, - 3866, - 4845, - 4689, - 2097, - 4889, - 5142, - 4167, - 4161, - 3874, - 5204, - 4876, - 4874, - 5054, - 3689, - 5026, - 4713, - 4728, 2112, 2115, - 2569, + 2118, 2128, + 2131, 2193, 2196, - 2131, - 2217, - 2220, 2211, 2214, - 2118, - 2378, - 2381, + 2217, + 2220, 2304, 2307, 2318, 2342, 2345, - 2477, + 2378, + 2381, 2404, 2422, - 2480, 2474, + 2477, + 2480, 2528, 2531, 2551, 2554, 2557, 2566, + 2569, 2580, - 2595, 2592, - 4177, - 4173, - 3697, - 4910, - 5184, - 3876, - 3870, - 4112, - 4853, - 2100, + 2595, + 2814, + 4880, + 4879, + 4881, + 3356, + 3357, + 3358, + 3359, + 3374, + 3634, + 3695, + 3699, + 3703, + 5129, + 4951, + 4054, + 4955, + 4952, + 4058, + 4064, + 3813, + 3814, + 3819, + 3825, 3839, - 3845, - 4840, - 2035 + 3846, + 3849, + 3852, + 3864, + 3873, + 3877, + 4941, + 3881, + 3883, + 3892, + 5029, + 4882, + 3980, + 3984, + 3989, + 3990, + 4048, + 4053, + 4106, + 4119, + 4125, + 4134, + 4142, + 5034, + 5171, + 5042, + 4806, + 4769, + 4569, + 4851, + 4160, + 4161, + 4162, + 4168, + 4174, + 5033, + 4760, + 4180, + 4184, + 4899, + 5062, + 5055, + 4913, + 5047, + 5051, + 4906, + 4425, + 4730, + 4868, + 4393, + 4696, + 4413, + 5181, + 4964, + 5107, + 5117, + 5207, + 5167, + 4914, + 5083, + 5014, + 4720, + 4735 ] }, { "title": "Variables", "children": [ - 733, - 5235, - 3623, - 1159, - 2192, - 736, - 2210, - 2209, - 2303, - 2302, - 2317, - 2315, - 2377, - 2402, - 2419, - 2439, - 2440, - 2591, - 997, 32, 64, 65, 140, 183, - 214, - 215, 212, 213, - 388, - 387, - 389, + 214, + 215, 386, - 1277, + 387, + 388, + 389, 453, 454, 484, - 486, 485, - 652, + 486, 651, + 652, + 732, + 733, + 736, + 996, + 997, + 1016, + 1034, 1063, 1064, - 1034, 1158, - 1276, - 1275, - 1278, + 1159, + 1160, 1236, 1237, 1258, 1259, + 1275, + 1276, + 1277, + 1278, 1536, 1537, 1662, + 1663, 1604, 1605, + 1628, + 1629, + 1630, + 1631, + 1748, 1787, 1788, 1810, 1811, - 1884, - 1883, - 1897, - 1896, - 2067, - 2066, - 1748, - 996, - 2341, - 1016, - 1160, - 1628, 1860, - 1629, - 1663, - 1631, - 1630, + 1883, + 1884, + 1896, + 1897, + 2066, + 2067, 2126, 2127, - 2372, 2191, - 2208, + 2192, 2207, - 2301, + 2208, + 2209, + 2210, 2300, - 2316, + 2301, + 2302, + 2303, 2314, - 2376, + 2315, + 2316, + 2317, + 2341, 2371, - 2441, + 2372, + 2376, + 2377, 2401, + 2402, 2403, + 2419, 2420, 2421, - 2438, 2437, - 2527, + 2438, + 2439, + 2440, + 2441, 2526, + 2527, 2549, 2550, - 2579, 2578, + 2579, 2590, - 732, - 3797 + 2591, + 3629, + 3804, + 5220 ] }, { "title": "Functions", "children": [ - 4236, - 4320, - 4204, - 758, - 2622, 2624, - 4200, - 4194, - 4212, + 2622, + 2634, 2637, - 4271, - 4219, - 4224, - 4227, + 2642, 2647, 2626, - 3833, - 4275, - 4244, - 4247, - 2642, - 4279, - 4251, - 4257, - 4260, - 3240, - 4263, - 4283, 2652, - 4209, - 4266, - 4184, - 4294, - 4303, 2659, - 428, - 4233, - 4230, - 4288, - 4307, 2661, 2671, 2680, 2692, + 428, 605, - 2025, + 758, 827, - 4313, - 4187, - 2634 + 2025, + 3246, + 3840, + 4201, + 4207, + 4211, + 4216, + 4219, + 4226, + 4231, + 4234, + 4237, + 4240, + 4243, + 4251, + 4254, + 4258, + 4264, + 4267, + 4270, + 4273, + 4278, + 4282, + 4286, + 4290, + 4295, + 4301, + 4310, + 4314, + 4320, + 4191, + 4194, + 4327 ] } ], @@ -130089,45 +132958,29 @@ "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", "qualifiedName": "AbstractFileService" }, - "2921": { - "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "AbstractFileService._isFileService" - }, - "2922": { - "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "AbstractFileService.isFileService" - }, - "2923": { - "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "AbstractFileService.isFileService" - }, - "2924": { - "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "object" - }, "2925": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__constructor" + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.__constructor" }, "2926": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", "qualifiedName": "AbstractFileService" }, "2927": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__container__" + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "container" }, "2928": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__configModule__" + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "config" }, "2929": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__moduleDeclaration__" + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.container" }, "2930": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "AbstractFileService.upload" + "qualifiedName": "AbstractFileService.config" }, "2931": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", @@ -130135,11 +132988,11 @@ }, "2932": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "fileData" + "qualifiedName": "AbstractFileService.upload" }, "2933": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "AbstractFileService.uploadProtected" + "qualifiedName": "fileData" }, "2934": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", @@ -130147,11 +133000,11 @@ }, "2935": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "fileData" + "qualifiedName": "AbstractFileService.uploadProtected" }, "2936": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "AbstractFileService.delete" + "qualifiedName": "fileData" }, "2937": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", @@ -130159,11 +133012,11 @@ }, "2938": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "fileData" + "qualifiedName": "AbstractFileService.delete" }, "2939": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "AbstractFileService.getUploadStreamDescriptor" + "qualifiedName": "fileData" }, "2940": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", @@ -130171,11 +133024,11 @@ }, "2941": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "fileData" + "qualifiedName": "AbstractFileService.getUploadStreamDescriptor" }, "2942": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "AbstractFileService.getDownloadStream" + "qualifiedName": "fileData" }, "2943": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", @@ -130183,11 +133036,11 @@ }, "2944": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "fileData" + "qualifiedName": "AbstractFileService.getDownloadStream" }, "2945": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "AbstractFileService.getPresignedDownloadUrl" + "qualifiedName": "fileData" }, "2946": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", @@ -130195,19 +133048,19 @@ }, "2947": { "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", - "qualifiedName": "fileData" + "qualifiedName": "AbstractFileService.getPresignedDownloadUrl" }, "2948": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.manager_" + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "fileData" }, "2949": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.transactionManager_" + "qualifiedName": "TransactionBaseService.manager_" }, "2950": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" + "qualifiedName": "TransactionBaseService.transactionManager_" }, "2951": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130215,19 +133068,19 @@ }, "2952": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__container__" + "qualifiedName": "TransactionBaseService.activeManager_" }, "2953": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__configModule__" + "qualifiedName": "TransactionBaseService.__container__" }, "2954": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + "qualifiedName": "TransactionBaseService.__configModule__" }, "2955": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, "2956": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130235,11 +133088,11 @@ }, "2957": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TransactionBaseService.withTransaction" }, "2958": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + "qualifiedName": "transactionManager" }, "2959": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130247,19 +133100,19 @@ }, "2960": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "err" + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, "2961": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "err" }, "2962": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type.code" + "qualifiedName": "__type" }, "2963": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" + "qualifiedName": "__type.code" }, "2964": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130267,19 +133120,19 @@ }, "2965": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TResult" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "2966": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TError" + "qualifiedName": "TResult" }, "2967": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "work" + "qualifiedName": "TError" }, "2968": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "work" }, "2969": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130287,15 +133140,15 @@ }, "2970": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "__type" }, "2971": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" + "qualifiedName": "transactionManager" }, "2972": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "isolationOrErrorHandler" }, "2973": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130303,15 +133156,15 @@ }, "2974": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "2975": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "maybeErrorHandlerOrDontFail" + "qualifiedName": "error" }, "2976": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "maybeErrorHandlerOrDontFail" }, "2977": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130319,23 +133172,23 @@ }, "2978": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "2979": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "2980": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", "qualifiedName": "FulfillmentService" }, - "2982": { - "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "FulfillmentService.getFulfillmentOptions" - }, "2983": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", "qualifiedName": "FulfillmentService.getFulfillmentOptions" }, "2984": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "FulfillmentService.validateFulfillmentData" + "qualifiedName": "FulfillmentService.getFulfillmentOptions" }, "2985": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130343,19 +133196,19 @@ }, "2986": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "optionData" + "qualifiedName": "FulfillmentService.validateFulfillmentData" }, "2987": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "optionData" }, "2988": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "cart" + "qualifiedName": "data" }, "2989": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "FulfillmentService.validateOption" + "qualifiedName": "cart" }, "2990": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130363,11 +133216,11 @@ }, "2991": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "FulfillmentService.validateOption" }, "2992": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "FulfillmentService.canCalculate" + "qualifiedName": "data" }, "2993": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130375,11 +133228,11 @@ }, "2994": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "FulfillmentService.canCalculate" }, "2995": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "FulfillmentService.calculatePrice" + "qualifiedName": "data" }, "2996": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130387,19 +133240,19 @@ }, "2997": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "optionData" + "qualifiedName": "FulfillmentService.calculatePrice" }, "2998": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "optionData" }, "2999": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "cart" + "qualifiedName": "data" }, "3000": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "FulfillmentService.createFulfillment" + "qualifiedName": "cart" }, "3001": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130407,23 +133260,23 @@ }, "3002": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "FulfillmentService.createFulfillment" }, "3003": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "items" + "qualifiedName": "data" }, "3004": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "order" + "qualifiedName": "items" }, "3005": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "fulfillment" + "qualifiedName": "order" }, "3006": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "FulfillmentService.cancelFulfillment" + "qualifiedName": "fulfillment" }, "3007": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130431,11 +133284,11 @@ }, "3008": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "fulfillmentData" + "qualifiedName": "FulfillmentService.cancelFulfillment" }, "3009": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "FulfillmentService.createReturn" + "qualifiedName": "fulfillmentData" }, "3010": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130443,11 +133296,11 @@ }, "3011": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "returnOrder" + "qualifiedName": "FulfillmentService.createReturn" }, "3012": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "FulfillmentService.getFulfillmentDocuments" + "qualifiedName": "returnOrder" }, "3013": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130455,11 +133308,11 @@ }, "3014": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "FulfillmentService.getFulfillmentDocuments" }, "3015": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "FulfillmentService.getReturnDocuments" + "qualifiedName": "data" }, "3016": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130467,11 +133320,11 @@ }, "3017": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "FulfillmentService.getReturnDocuments" }, "3018": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "FulfillmentService.getShipmentDocuments" + "qualifiedName": "data" }, "3019": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130479,11 +133332,11 @@ }, "3020": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "FulfillmentService.getShipmentDocuments" }, "3021": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "FulfillmentService.retrieveDocuments" + "qualifiedName": "data" }, "3022": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130491,23 +133344,23 @@ }, "3023": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "fulfillmentData" + "qualifiedName": "FulfillmentService.retrieveDocuments" }, "3024": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "documentType" + "qualifiedName": "fulfillmentData" }, "3025": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.manager_" + "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", + "qualifiedName": "documentType" }, "3026": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.transactionManager_" + "qualifiedName": "TransactionBaseService.manager_" }, "3027": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" + "qualifiedName": "TransactionBaseService.transactionManager_" }, "3028": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130515,19 +133368,19 @@ }, "3029": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__container__" + "qualifiedName": "TransactionBaseService.activeManager_" }, "3030": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__configModule__" + "qualifiedName": "TransactionBaseService.__container__" }, "3031": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + "qualifiedName": "TransactionBaseService.__configModule__" }, "3032": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, "3033": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130535,11 +133388,11 @@ }, "3034": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TransactionBaseService.withTransaction" }, "3035": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + "qualifiedName": "transactionManager" }, "3036": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130547,19 +133400,19 @@ }, "3037": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "err" + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, "3038": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "err" }, "3039": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type.code" + "qualifiedName": "__type" }, "3040": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" + "qualifiedName": "__type.code" }, "3041": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130567,19 +133420,19 @@ }, "3042": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TResult" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "3043": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TError" + "qualifiedName": "TResult" }, "3044": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "work" + "qualifiedName": "TError" }, "3045": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "work" }, "3046": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130587,15 +133440,15 @@ }, "3047": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "__type" }, "3048": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" + "qualifiedName": "transactionManager" }, "3049": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "isolationOrErrorHandler" }, "3050": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130603,15 +133456,15 @@ }, "3051": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "3052": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "maybeErrorHandlerOrDontFail" + "qualifiedName": "error" }, "3053": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "maybeErrorHandlerOrDontFail" }, "3054": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130619,43 +133472,43 @@ }, "3055": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "3056": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "3057": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", "qualifiedName": "AbstractFulfillmentService" }, - "3061": { - "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.identifier" - }, "3062": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.__constructor" + "qualifiedName": "AbstractFulfillmentService.identifier" }, "3063": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService" + "qualifiedName": "AbstractFulfillmentService.__constructor" }, "3064": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "container" + "qualifiedName": "AbstractFulfillmentService" }, "3065": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "config" + "qualifiedName": "container" }, "3066": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.container" + "qualifiedName": "config" }, "3067": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.config" + "qualifiedName": "AbstractFulfillmentService.container" }, - "3070": { + "3068": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.getFulfillmentOptions" + "qualifiedName": "AbstractFulfillmentService.config" }, "3071": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130663,7 +133516,7 @@ }, "3072": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.validateFulfillmentData" + "qualifiedName": "AbstractFulfillmentService.getFulfillmentOptions" }, "3073": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130671,19 +133524,19 @@ }, "3074": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "optionData" + "qualifiedName": "AbstractFulfillmentService.validateFulfillmentData" }, "3075": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "optionData" }, "3076": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "cart" + "qualifiedName": "data" }, "3077": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.validateOption" + "qualifiedName": "cart" }, "3078": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130691,11 +133544,11 @@ }, "3079": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "AbstractFulfillmentService.validateOption" }, "3080": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.canCalculate" + "qualifiedName": "data" }, "3081": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130703,11 +133556,11 @@ }, "3082": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "AbstractFulfillmentService.canCalculate" }, "3083": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.calculatePrice" + "qualifiedName": "data" }, "3084": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130715,19 +133568,19 @@ }, "3085": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "optionData" + "qualifiedName": "AbstractFulfillmentService.calculatePrice" }, "3086": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "optionData" }, "3087": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "cart" + "qualifiedName": "data" }, "3088": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.createFulfillment" + "qualifiedName": "cart" }, "3089": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130735,23 +133588,23 @@ }, "3090": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "AbstractFulfillmentService.createFulfillment" }, "3091": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "items" + "qualifiedName": "data" }, "3092": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "order" + "qualifiedName": "items" }, "3093": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "fulfillment" + "qualifiedName": "order" }, "3094": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.cancelFulfillment" + "qualifiedName": "fulfillment" }, "3095": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130759,11 +133612,11 @@ }, "3096": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "fulfillment" + "qualifiedName": "AbstractFulfillmentService.cancelFulfillment" }, "3097": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.createReturn" + "qualifiedName": "fulfillment" }, "3098": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130771,11 +133624,11 @@ }, "3099": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "returnOrder" + "qualifiedName": "AbstractFulfillmentService.createReturn" }, "3100": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.getFulfillmentDocuments" + "qualifiedName": "returnOrder" }, "3101": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130783,11 +133636,11 @@ }, "3102": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "AbstractFulfillmentService.getFulfillmentDocuments" }, "3103": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.getReturnDocuments" + "qualifiedName": "data" }, "3104": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130795,11 +133648,11 @@ }, "3105": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "AbstractFulfillmentService.getReturnDocuments" }, "3106": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.getShipmentDocuments" + "qualifiedName": "data" }, "3107": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130807,11 +133660,11 @@ }, "3108": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "data" + "qualifiedName": "AbstractFulfillmentService.getShipmentDocuments" }, "3109": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "AbstractFulfillmentService.retrieveDocuments" + "qualifiedName": "data" }, "3110": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", @@ -130819,23 +133672,23 @@ }, "3111": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "fulfillmentData" + "qualifiedName": "AbstractFulfillmentService.retrieveDocuments" }, "3112": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", - "qualifiedName": "documentType" + "qualifiedName": "fulfillmentData" }, "3113": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.manager_" + "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", + "qualifiedName": "documentType" }, "3114": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.transactionManager_" + "qualifiedName": "TransactionBaseService.manager_" }, "3115": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" + "qualifiedName": "TransactionBaseService.transactionManager_" }, "3116": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130843,19 +133696,19 @@ }, "3117": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__container__" + "qualifiedName": "TransactionBaseService.activeManager_" }, "3118": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__configModule__" + "qualifiedName": "TransactionBaseService.__container__" }, "3119": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + "qualifiedName": "TransactionBaseService.__configModule__" }, "3120": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, "3121": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130863,11 +133716,11 @@ }, "3122": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TransactionBaseService.withTransaction" }, "3123": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + "qualifiedName": "transactionManager" }, "3124": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130875,19 +133728,19 @@ }, "3125": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "err" + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, "3126": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "err" }, "3127": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type.code" + "qualifiedName": "__type" }, "3128": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" + "qualifiedName": "__type.code" }, "3129": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130895,19 +133748,19 @@ }, "3130": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TResult" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "3131": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TError" + "qualifiedName": "TResult" }, "3132": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "work" + "qualifiedName": "TError" }, "3133": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "work" }, "3134": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130915,15 +133768,15 @@ }, "3135": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "__type" }, "3136": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" + "qualifiedName": "transactionManager" }, "3137": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "isolationOrErrorHandler" }, "3138": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130931,15 +133784,15 @@ }, "3139": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "3140": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "maybeErrorHandlerOrDontFail" + "qualifiedName": "error" }, "3141": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "maybeErrorHandlerOrDontFail" }, "3142": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -130947,151 +133800,151 @@ }, "3143": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "3144": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "INotificationService" + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" }, "3145": { "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "INotificationService.sendNotification" + "qualifiedName": "ReturnedData" }, "3146": { "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "INotificationService.sendNotification" + "qualifiedName": "__type.to" }, "3147": { "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "event" + "qualifiedName": "__type.status" }, "3148": { "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "data" + "qualifiedName": "__type.data" }, "3149": { "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "attachmentGenerator" + "qualifiedName": "INotificationService" }, "3150": { "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "INotificationService.resendNotification" + "qualifiedName": "INotificationService.sendNotification" }, "3151": { "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "INotificationService.resendNotification" + "qualifiedName": "INotificationService.sendNotification" }, "3152": { "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "notification" + "qualifiedName": "event" }, "3153": { "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "config" + "qualifiedName": "data" }, "3154": { "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", "qualifiedName": "attachmentGenerator" }, "3155": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.manager_" + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "INotificationService.resendNotification" }, "3156": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.transactionManager_" + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "INotificationService.resendNotification" }, "3157": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "notification" }, "3158": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "config" }, "3159": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__container__" + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "attachmentGenerator" }, "3160": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__configModule__" + "qualifiedName": "TransactionBaseService.manager_" }, "3161": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + "qualifiedName": "TransactionBaseService.transactionManager_" }, "3162": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" + "qualifiedName": "TransactionBaseService.activeManager_" }, "3163": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" + "qualifiedName": "TransactionBaseService.activeManager_" }, "3164": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TransactionBaseService.__container__" }, "3165": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + "qualifiedName": "TransactionBaseService.__configModule__" }, "3166": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, "3167": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "err" + "qualifiedName": "TransactionBaseService.withTransaction" }, "3168": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "TransactionBaseService.withTransaction" }, "3169": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type.code" + "qualifiedName": "transactionManager" }, "3170": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, "3171": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, "3172": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TResult" + "qualifiedName": "err" }, "3173": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TError" + "qualifiedName": "__type" }, "3174": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "work" + "qualifiedName": "__type.code" }, "3175": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "3176": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "3177": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TResult" }, "3178": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" + "qualifiedName": "TError" }, "3179": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "work" }, "3180": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -131099,15 +133952,15 @@ }, "3181": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "3182": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "maybeErrorHandlerOrDontFail" + "qualifiedName": "transactionManager" }, "3183": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "isolationOrErrorHandler" }, "3184": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -131115,411 +133968,387 @@ }, "3185": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "3186": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "AbstractNotificationService" - }, - "3187": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "AbstractNotificationService._isNotificationService" - }, - "3188": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "AbstractNotificationService.identifier" - }, - "3189": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "AbstractNotificationService.isNotificationService" - }, - "3190": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "AbstractNotificationService.isNotificationService" - }, - "3191": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "object" - }, - "3192": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__constructor" - }, - "3193": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "AbstractNotificationService" - }, - "3194": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__container__" - }, - "3195": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__configModule__" - }, - "3196": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__moduleDeclaration__" - }, - "3197": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "AbstractNotificationService.getIdentifier" - }, - "3198": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "AbstractNotificationService.getIdentifier" - }, - "3199": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "AbstractNotificationService.sendNotification" - }, - "3200": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "AbstractNotificationService.sendNotification" - }, - "3201": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "event" - }, - "3202": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "data" - }, - "3203": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "attachmentGenerator" - }, - "3204": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "AbstractNotificationService.resendNotification" - }, - "3205": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "AbstractNotificationService.resendNotification" - }, - "3206": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "notification" - }, - "3207": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "config" - }, - "3208": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "attachmentGenerator" - }, - "3209": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.manager_" - }, - "3210": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.transactionManager_" - }, - "3211": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" - }, - "3212": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" - }, - "3213": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__container__" - }, - "3214": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__configModule__" - }, - "3215": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__moduleDeclaration__" - }, - "3216": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" - }, - "3217": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" - }, - "3218": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" - }, - "3219": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" - }, - "3220": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" - }, - "3221": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "err" - }, - "3222": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3223": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type.code" - }, - "3224": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" - }, - "3225": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" - }, - "3226": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TResult" - }, - "3227": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TError" - }, - "3228": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "work" - }, - "3229": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3230": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3231": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" - }, - "3232": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" - }, - "3233": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3234": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3235": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3236": { + "3187": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "3237": { + "3188": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3238": { + "3189": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3239": { + "3190": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, + "3191": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService" + }, + "3193": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.identifier" + }, + "3197": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.__constructor" + }, + "3198": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService" + }, + "3199": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "container" + }, + "3200": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "config" + }, + "3203": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.container" + }, + "3204": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.config" + }, + "3205": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.sendNotification" + }, + "3206": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.sendNotification" + }, + "3207": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "event" + }, + "3208": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "data" + }, + "3209": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "attachmentGenerator" + }, + "3210": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.resendNotification" + }, + "3211": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.resendNotification" + }, + "3212": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "notification" + }, + "3213": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "config" + }, + "3214": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "attachmentGenerator" + }, + "3215": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.manager_" + }, + "3216": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.transactionManager_" + }, + "3217": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "3218": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "3219": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__container__" + }, + "3220": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__configModule__" + }, + "3221": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + }, + "3222": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "3223": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "3224": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "3225": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "3226": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "3227": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "err" + }, + "3228": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3229": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type.code" + }, + "3230": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "3231": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "3232": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TResult" + }, + "3233": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TError" + }, + "3234": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "work" + }, + "3235": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3236": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3237": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "3238": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "isolationOrErrorHandler" + }, + "3239": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, "3240": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "isPaymentProcessorError" + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" }, "3241": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "isPaymentProcessorError" + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" }, "3242": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "obj" + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "maybeErrorHandlerOrDontFail" }, "3243": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessorContext" + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" }, "3244": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.billing_address" + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" }, "3245": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.email" + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" }, "3246": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.currency_code" + "qualifiedName": "isPaymentProcessorError" }, "3247": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.amount" + "qualifiedName": "isPaymentProcessorError" }, "3248": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.resource_id" + "qualifiedName": "obj" }, "3249": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.customer" + "qualifiedName": "PaymentProcessorContext" }, "3250": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.context" + "qualifiedName": "__type.billing_address" }, "3251": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.paymentSessionData" + "qualifiedName": "__type.email" }, "3252": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessorSessionResponse" + "qualifiedName": "__type.currency_code" }, "3253": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.update_requests" + "qualifiedName": "__type.amount" }, "3254": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.resource_id" }, "3255": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.customer_metadata" + "qualifiedName": "__type.customer" }, "3256": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.session_data" + "qualifiedName": "__type.context" }, "3257": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessorError" + "qualifiedName": "__type.paymentSessionData" }, "3258": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessorError.error" + "qualifiedName": "PaymentProcessorSessionResponse" }, "3259": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessorError.code" + "qualifiedName": "__type.update_requests" }, "3260": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessorError.detail" + "qualifiedName": "__type" }, "3261": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor" + "qualifiedName": "__type.customer_metadata" + }, + "3262": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", + "qualifiedName": "__type.session_data" + }, + "3263": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", + "qualifiedName": "PaymentProcessorError" }, "3264": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.initiatePayment" + "qualifiedName": "PaymentProcessorError.error" }, "3265": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.initiatePayment" + "qualifiedName": "PaymentProcessorError.code" }, "3266": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "context" + "qualifiedName": "PaymentProcessorError.detail" }, "3267": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.updatePayment" - }, - "3268": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.updatePayment" - }, - "3269": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "context" + "qualifiedName": "PaymentProcessor" }, "3270": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.refundPayment" + "qualifiedName": "PaymentProcessor.initiatePayment" }, "3271": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.refundPayment" + "qualifiedName": "PaymentProcessor.initiatePayment" }, "3272": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "paymentSessionData" + "qualifiedName": "context" }, "3273": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "refundAmount" + "qualifiedName": "PaymentProcessor.updatePayment" }, "3274": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.authorizePayment" + "qualifiedName": "PaymentProcessor.updatePayment" }, "3275": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.authorizePayment" + "qualifiedName": "context" }, "3276": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "paymentSessionData" + "qualifiedName": "PaymentProcessor.refundPayment" }, "3277": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "context" + "qualifiedName": "PaymentProcessor.refundPayment" }, "3278": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type" + "qualifiedName": "paymentSessionData" }, "3279": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.status" + "qualifiedName": "refundAmount" }, "3280": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.data" + "qualifiedName": "PaymentProcessor.authorizePayment" }, "3281": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.capturePayment" + "qualifiedName": "PaymentProcessor.authorizePayment" }, "3282": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.capturePayment" + "qualifiedName": "paymentSessionData" }, "3283": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "paymentSessionData" + "qualifiedName": "context" }, "3284": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.deletePayment" + "qualifiedName": "__type" }, "3285": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.deletePayment" + "qualifiedName": "__type.status" }, "3286": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "paymentSessionData" + "qualifiedName": "__type.data" }, "3287": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.retrievePayment" + "qualifiedName": "PaymentProcessor.capturePayment" }, "3288": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.retrievePayment" + "qualifiedName": "PaymentProcessor.capturePayment" }, "3289": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", @@ -131527,11 +134356,11 @@ }, "3290": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.cancelPayment" + "qualifiedName": "PaymentProcessor.deletePayment" }, "3291": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.cancelPayment" + "qualifiedName": "PaymentProcessor.deletePayment" }, "3292": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", @@ -131539,11 +134368,11 @@ }, "3293": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.getPaymentStatus" + "qualifiedName": "PaymentProcessor.retrievePayment" }, "3294": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.getPaymentStatus" + "qualifiedName": "PaymentProcessor.retrievePayment" }, "3295": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", @@ -131551,139 +134380,139 @@ }, "3296": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.updatePaymentData" + "qualifiedName": "PaymentProcessor.cancelPayment" }, "3297": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "PaymentProcessor.updatePaymentData" + "qualifiedName": "PaymentProcessor.cancelPayment" }, "3298": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "sessionId" + "qualifiedName": "paymentSessionData" }, "3299": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "data" + "qualifiedName": "PaymentProcessor.getPaymentStatus" }, "3300": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor" + "qualifiedName": "PaymentProcessor.getPaymentStatus" }, "3301": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor._isPaymentProcessor" + "qualifiedName": "paymentSessionData" }, "3302": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.isPaymentProcessor" + "qualifiedName": "PaymentProcessor.updatePaymentData" }, "3303": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.isPaymentProcessor" + "qualifiedName": "PaymentProcessor.updatePaymentData" }, "3304": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "object" + "qualifiedName": "sessionId" }, "3305": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.identifier" + "qualifiedName": "data" }, "3306": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.__constructor" + "qualifiedName": "AbstractPaymentProcessor" }, "3307": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor" + "qualifiedName": "AbstractPaymentProcessor._isPaymentProcessor" }, "3308": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "container" + "qualifiedName": "AbstractPaymentProcessor.isPaymentProcessor" }, "3309": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "config" + "qualifiedName": "AbstractPaymentProcessor.isPaymentProcessor" }, "3310": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.container" + "qualifiedName": "object" }, "3311": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.config" + "qualifiedName": "AbstractPaymentProcessor.identifier" + }, + "3312": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", + "qualifiedName": "AbstractPaymentProcessor.__constructor" + }, + "3313": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", + "qualifiedName": "AbstractPaymentProcessor" }, "3314": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.capturePayment" + "qualifiedName": "container" }, "3315": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.capturePayment" + "qualifiedName": "config" }, "3316": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "paymentSessionData" + "qualifiedName": "AbstractPaymentProcessor.container" }, "3317": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.authorizePayment" - }, - "3318": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.authorizePayment" - }, - "3319": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "paymentSessionData" + "qualifiedName": "AbstractPaymentProcessor.config" }, "3320": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "context" + "qualifiedName": "AbstractPaymentProcessor.capturePayment" }, "3321": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type" + "qualifiedName": "AbstractPaymentProcessor.capturePayment" }, "3322": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.status" + "qualifiedName": "paymentSessionData" }, "3323": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "__type.data" + "qualifiedName": "AbstractPaymentProcessor.authorizePayment" }, "3324": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.cancelPayment" + "qualifiedName": "AbstractPaymentProcessor.authorizePayment" }, "3325": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.cancelPayment" + "qualifiedName": "paymentSessionData" }, "3326": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "paymentSessionData" + "qualifiedName": "context" }, "3327": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.initiatePayment" + "qualifiedName": "__type" }, "3328": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.initiatePayment" + "qualifiedName": "__type.status" }, "3329": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "context" + "qualifiedName": "__type.data" }, "3330": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.deletePayment" + "qualifiedName": "AbstractPaymentProcessor.cancelPayment" }, "3331": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.deletePayment" + "qualifiedName": "AbstractPaymentProcessor.cancelPayment" }, "3332": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", @@ -131691,23 +134520,23 @@ }, "3333": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.getPaymentStatus" + "qualifiedName": "AbstractPaymentProcessor.initiatePayment" }, "3334": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.getPaymentStatus" + "qualifiedName": "AbstractPaymentProcessor.initiatePayment" }, "3335": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "paymentSessionData" + "qualifiedName": "context" }, "3336": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.refundPayment" + "qualifiedName": "AbstractPaymentProcessor.deletePayment" }, "3337": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.refundPayment" + "qualifiedName": "AbstractPaymentProcessor.deletePayment" }, "3338": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", @@ -131715,1075 +134544,1055 @@ }, "3339": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "refundAmount" + "qualifiedName": "AbstractPaymentProcessor.getPaymentStatus" }, "3340": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.retrievePayment" + "qualifiedName": "AbstractPaymentProcessor.getPaymentStatus" }, "3341": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.retrievePayment" + "qualifiedName": "paymentSessionData" }, "3342": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "paymentSessionData" + "qualifiedName": "AbstractPaymentProcessor.refundPayment" }, "3343": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.updatePayment" + "qualifiedName": "AbstractPaymentProcessor.refundPayment" }, "3344": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.updatePayment" + "qualifiedName": "paymentSessionData" }, "3345": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "context" + "qualifiedName": "refundAmount" }, "3346": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.updatePaymentData" + "qualifiedName": "AbstractPaymentProcessor.retrievePayment" }, "3347": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "AbstractPaymentProcessor.updatePaymentData" + "qualifiedName": "AbstractPaymentProcessor.retrievePayment" }, "3348": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "sessionId" + "qualifiedName": "paymentSessionData" }, "3349": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", - "qualifiedName": "data" + "qualifiedName": "AbstractPaymentProcessor.updatePayment" }, "3350": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "Data" + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", + "qualifiedName": "AbstractPaymentProcessor.updatePayment" }, "3351": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentData" + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", + "qualifiedName": "context" }, "3352": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentSessionData" + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", + "qualifiedName": "AbstractPaymentProcessor.updatePaymentData" }, "3353": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentContext" + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", + "qualifiedName": "AbstractPaymentProcessor.updatePaymentData" }, "3354": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", + "qualifiedName": "sessionId" }, "3355": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.cart" + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-processor.ts", + "qualifiedName": "data" }, "3356": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type" + "qualifiedName": "Data" }, "3357": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.context" + "qualifiedName": "PaymentData" }, "3358": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.id" + "qualifiedName": "PaymentSessionData" }, "3359": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.email" + "qualifiedName": "PaymentContext" }, "3360": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.shipping_address" + "qualifiedName": "__type" }, "3361": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.shipping_methods" + "qualifiedName": "__type.cart" }, "3362": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.billing_address" + "qualifiedName": "__type" }, "3363": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.currency_code" + "qualifiedName": "__type.context" }, "3364": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.amount" + "qualifiedName": "__type.id" }, "3365": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.resource_id" + "qualifiedName": "__type.email" }, "3366": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.customer" + "qualifiedName": "__type.shipping_address" }, "3367": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.paymentSessionData" + "qualifiedName": "__type.shipping_methods" }, "3368": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentSessionResponse" + "qualifiedName": "__type.billing_address" }, "3369": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.currency_code" }, "3370": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.update_requests" + "qualifiedName": "__type.amount" }, "3371": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.resource_id" }, "3372": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.customer_metadata" + "qualifiedName": "__type.customer" }, "3373": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.session_data" + "qualifiedName": "__type.paymentSessionData" }, "3374": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService" + "qualifiedName": "PaymentSessionResponse" }, "3375": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.getIdentifier" + "qualifiedName": "__type" }, "3376": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.getIdentifier" + "qualifiedName": "__type.update_requests" }, "3377": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.getPaymentData" + "qualifiedName": "__type" }, "3378": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.getPaymentData" + "qualifiedName": "__type.customer_metadata" }, "3379": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentSession" + "qualifiedName": "__type.session_data" }, "3380": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.updatePaymentData" + "qualifiedName": "PaymentService" }, "3381": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.updatePaymentData" + "qualifiedName": "PaymentService.getIdentifier" }, "3382": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentSessionData" + "qualifiedName": "PaymentService.getIdentifier" }, "3383": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "data" + "qualifiedName": "PaymentService.getPaymentData" }, "3384": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.createPayment" + "qualifiedName": "PaymentService.getPaymentData" }, "3385": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.createPayment" + "qualifiedName": "paymentSession" }, "3386": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "context" + "qualifiedName": "PaymentService.updatePaymentData" }, "3387": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.createPayment" + "qualifiedName": "PaymentService.updatePaymentData" }, "3388": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "cart" + "qualifiedName": "paymentSessionData" }, "3389": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.retrievePayment" + "qualifiedName": "data" }, "3390": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.retrievePayment" + "qualifiedName": "PaymentService.createPayment" }, "3391": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentData" + "qualifiedName": "PaymentService.createPayment" }, "3392": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.updatePayment" + "qualifiedName": "context" }, "3393": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.updatePayment" + "qualifiedName": "PaymentService.createPayment" }, "3394": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentSessionData" + "qualifiedName": "cart" }, "3395": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "context" + "qualifiedName": "PaymentService.retrievePayment" }, "3396": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.updatePayment" + "qualifiedName": "PaymentService.retrievePayment" }, "3397": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentSessionData" + "qualifiedName": "paymentData" }, "3398": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "cart" + "qualifiedName": "PaymentService.updatePayment" }, "3399": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.authorizePayment" + "qualifiedName": "PaymentService.updatePayment" }, "3400": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.authorizePayment" + "qualifiedName": "paymentSessionData" }, "3401": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentSession" + "qualifiedName": "context" }, "3402": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "context" + "qualifiedName": "PaymentService.updatePayment" }, "3403": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type" + "qualifiedName": "paymentSessionData" }, "3404": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.data" + "qualifiedName": "cart" }, "3405": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.status" + "qualifiedName": "PaymentService.authorizePayment" }, "3406": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.capturePayment" + "qualifiedName": "PaymentService.authorizePayment" }, "3407": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.capturePayment" + "qualifiedName": "paymentSession" }, "3408": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "payment" + "qualifiedName": "context" }, "3409": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.refundPayment" + "qualifiedName": "__type" }, "3410": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.refundPayment" + "qualifiedName": "__type.data" }, "3411": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "payment" + "qualifiedName": "__type.status" }, "3412": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "refundAmount" + "qualifiedName": "PaymentService.capturePayment" }, "3413": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.cancelPayment" + "qualifiedName": "PaymentService.capturePayment" }, "3414": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.cancelPayment" + "qualifiedName": "payment" }, "3415": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "payment" + "qualifiedName": "PaymentService.refundPayment" }, "3416": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.deletePayment" + "qualifiedName": "PaymentService.refundPayment" }, "3417": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.deletePayment" + "qualifiedName": "payment" }, "3418": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentSession" + "qualifiedName": "refundAmount" }, "3419": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.retrieveSavedMethods" + "qualifiedName": "PaymentService.cancelPayment" }, "3420": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.retrieveSavedMethods" + "qualifiedName": "PaymentService.cancelPayment" }, "3421": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "customer" + "qualifiedName": "payment" }, "3422": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.getStatus" + "qualifiedName": "PaymentService.deletePayment" }, "3423": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "PaymentService.getStatus" + "qualifiedName": "PaymentService.deletePayment" }, "3424": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "data" + "qualifiedName": "paymentSession" }, "3425": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.manager_" + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "PaymentService.retrieveSavedMethods" }, "3426": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.transactionManager_" + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "PaymentService.retrieveSavedMethods" }, "3427": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" - }, - "3428": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" - }, - "3429": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__container__" - }, - "3430": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__configModule__" - }, - "3431": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__moduleDeclaration__" - }, - "3432": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" - }, - "3433": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" - }, - "3434": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" - }, - "3435": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" - }, - "3436": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" - }, - "3437": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "err" - }, - "3438": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3439": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type.code" - }, - "3440": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" - }, - "3441": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" - }, - "3442": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TResult" - }, - "3443": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TError" - }, - "3444": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "work" - }, - "3445": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3446": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3447": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" - }, - "3448": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" - }, - "3449": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3450": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3451": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" - }, - "3452": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "maybeErrorHandlerOrDontFail" - }, - "3453": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3454": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3455": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" - }, - "3456": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService" - }, - "3457": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService._isPaymentService" - }, - "3461": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.identifier" - }, - "3462": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.__constructor" - }, - "3463": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService" - }, - "3464": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "container" - }, - "3465": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "config" - }, - "3466": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.getIdentifier" - }, - "3467": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.getIdentifier" - }, - "3468": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.getPaymentData" - }, - "3469": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.getPaymentData" - }, - "3470": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentSession" - }, - "3471": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.updatePaymentData" - }, - "3472": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.updatePaymentData" - }, - "3473": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentSessionData" - }, - "3474": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "data" - }, - "3475": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.createPayment" - }, - "3476": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.createPayment" - }, - "3477": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "context" - }, - "3478": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.createPayment" - }, - "3479": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "cart" - }, - "3480": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.retrievePayment" - }, - "3481": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.retrievePayment" - }, - "3482": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentData" - }, - "3483": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.updatePayment" - }, - "3484": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.updatePayment" - }, - "3485": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentSessionData" - }, - "3486": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "context" - }, - "3487": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.updatePayment" - }, - "3488": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentSessionData" - }, - "3489": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "cart" - }, - "3490": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.authorizePayment" - }, - "3491": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.authorizePayment" - }, - "3492": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentSession" - }, - "3493": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "context" - }, - "3494": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type" - }, - "3495": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.data" - }, - "3496": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "__type.status" - }, - "3497": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.capturePayment" - }, - "3498": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.capturePayment" - }, - "3499": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "payment" - }, - "3500": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.refundPayment" - }, - "3501": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.refundPayment" - }, - "3502": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "payment" - }, - "3503": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "refundAmount" - }, - "3504": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.cancelPayment" - }, - "3505": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.cancelPayment" - }, - "3506": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "payment" - }, - "3507": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.deletePayment" - }, - "3508": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.deletePayment" - }, - "3509": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "paymentSession" - }, - "3510": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.retrieveSavedMethods" - }, - "3511": { - "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.retrieveSavedMethods" - }, - "3512": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", "qualifiedName": "customer" }, - "3513": { + "3428": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.getStatus" + "qualifiedName": "PaymentService.getStatus" }, - "3514": { + "3429": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", - "qualifiedName": "AbstractPaymentService.getStatus" + "qualifiedName": "PaymentService.getStatus" }, - "3515": { + "3430": { "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", "qualifiedName": "data" }, - "3516": { + "3431": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "3517": { + "3432": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "3518": { + "3433": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3519": { + "3434": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3520": { + "3435": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "3521": { + "3436": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "3522": { + "3437": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "3523": { + "3438": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3524": { + "3439": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3525": { + "3440": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3526": { + "3441": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3527": { + "3442": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3528": { + "3443": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "3529": { + "3444": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3530": { + "3445": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "3531": { + "3446": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3532": { + "3447": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3533": { + "3448": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "3534": { + "3449": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "3535": { + "3450": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, - "3536": { + "3451": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3537": { + "3452": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3538": { + "3453": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3539": { + "3454": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "isolationOrErrorHandler" }, - "3540": { + "3455": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3541": { + "3456": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3542": { + "3457": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3543": { + "3458": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "3544": { + "3459": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3545": { + "3460": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3546": { + "3461": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3547": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "IPriceSelectionStrategy" + "3462": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService" }, - "3548": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "IPriceSelectionStrategy.calculateVariantPrice" + "3463": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService._isPaymentService" }, - "3549": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "IPriceSelectionStrategy.calculateVariantPrice" + "3467": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.identifier" }, - "3550": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "3468": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.__constructor" + }, + "3469": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService" + }, + "3470": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "container" + }, + "3471": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "config" + }, + "3472": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.getIdentifier" + }, + "3473": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.getIdentifier" + }, + "3474": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.getPaymentData" + }, + "3475": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.getPaymentData" + }, + "3476": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "paymentSession" + }, + "3477": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.updatePaymentData" + }, + "3478": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.updatePaymentData" + }, + "3479": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "paymentSessionData" + }, + "3480": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", "qualifiedName": "data" }, - "3551": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type" + "3481": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.createPayment" }, - "3552": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.variantId" + "3482": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.createPayment" }, - "3553": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.quantity" - }, - "3554": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "3483": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", "qualifiedName": "context" }, - "3555": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "IPriceSelectionStrategy.onVariantsPricesUpdate" + "3484": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.createPayment" }, - "3556": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "IPriceSelectionStrategy.onVariantsPricesUpdate" + "3485": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "cart" }, - "3557": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "variantIds" + "3486": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.retrievePayment" }, - "3558": { - "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", - "qualifiedName": "ITransactionBaseService.withTransaction" + "3487": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.retrievePayment" }, - "3559": { - "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", - "qualifiedName": "ITransactionBaseService.withTransaction" + "3488": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "paymentData" }, - "3560": { - "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", - "qualifiedName": "transactionManager" + "3489": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.updatePayment" }, - "3561": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "AbstractPriceSelectionStrategy" + "3490": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.updatePayment" }, - "3562": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "AbstractPriceSelectionStrategy._isPriceSelectionStrategy" + "3491": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "paymentSessionData" }, - "3563": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "AbstractPriceSelectionStrategy.isPriceSelectionStrategy" + "3492": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "context" }, - "3564": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "AbstractPriceSelectionStrategy.isPriceSelectionStrategy" + "3493": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.updatePayment" }, - "3565": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "object" + "3494": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "paymentSessionData" }, - "3566": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__constructor" + "3495": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "cart" }, - "3567": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "AbstractPriceSelectionStrategy" + "3496": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.authorizePayment" }, - "3568": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__container__" + "3497": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.authorizePayment" }, - "3569": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__configModule__" + "3498": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "paymentSession" }, - "3570": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__moduleDeclaration__" + "3499": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "context" }, - "3571": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "AbstractPriceSelectionStrategy.calculateVariantPrice" + "3500": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "__type" }, - "3572": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "AbstractPriceSelectionStrategy.calculateVariantPrice" + "3501": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "__type.data" }, - "3573": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "3502": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "__type.status" + }, + "3503": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.capturePayment" + }, + "3504": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.capturePayment" + }, + "3505": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "payment" + }, + "3506": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.refundPayment" + }, + "3507": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.refundPayment" + }, + "3508": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "payment" + }, + "3509": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "refundAmount" + }, + "3510": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.cancelPayment" + }, + "3511": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.cancelPayment" + }, + "3512": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "payment" + }, + "3513": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.deletePayment" + }, + "3514": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.deletePayment" + }, + "3515": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "paymentSession" + }, + "3516": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.retrieveSavedMethods" + }, + "3517": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.retrieveSavedMethods" + }, + "3518": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "customer" + }, + "3519": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.getStatus" + }, + "3520": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", + "qualifiedName": "AbstractPaymentService.getStatus" + }, + "3521": { + "sourceFileName": "../../../packages/medusa/src/interfaces/payment-service.ts", "qualifiedName": "data" }, - "3574": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type" - }, - "3575": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.variantId" - }, - "3576": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.taxRates" - }, - "3577": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.quantity" - }, - "3578": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "context" - }, - "3579": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "AbstractPriceSelectionStrategy.onVariantsPricesUpdate" - }, - "3580": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "AbstractPriceSelectionStrategy.onVariantsPricesUpdate" - }, - "3581": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "variantIds" - }, - "3582": { + "3522": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "3583": { + "3523": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "3584": { + "3524": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3585": { + "3525": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3586": { + "3526": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "3587": { + "3527": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "3588": { + "3528": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "3589": { + "3529": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3590": { + "3530": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3591": { + "3531": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3592": { + "3532": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3593": { + "3533": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3594": { + "3534": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "3595": { + "3535": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3596": { + "3536": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "3597": { + "3537": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3598": { + "3538": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3599": { + "3539": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "3600": { + "3540": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "3601": { + "3541": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, + "3542": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3543": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3544": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "3545": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "isolationOrErrorHandler" + }, + "3546": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3547": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3548": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "3549": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "maybeErrorHandlerOrDontFail" + }, + "3550": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3551": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3552": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "3553": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "IPriceSelectionStrategy" + }, + "3554": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "IPriceSelectionStrategy.calculateVariantPrice" + }, + "3555": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "IPriceSelectionStrategy.calculateVariantPrice" + }, + "3556": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "data" + }, + "3557": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type" + }, + "3558": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.variantId" + }, + "3559": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.quantity" + }, + "3560": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "context" + }, + "3561": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "IPriceSelectionStrategy.onVariantsPricesUpdate" + }, + "3562": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "IPriceSelectionStrategy.onVariantsPricesUpdate" + }, + "3563": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "variantIds" + }, + "3564": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "ITransactionBaseService.withTransaction" + }, + "3565": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "ITransactionBaseService.withTransaction" + }, + "3566": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "transactionManager" + }, + "3567": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy" + }, + "3572": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.__constructor" + }, + "3573": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy" + }, + "3574": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "container" + }, + "3575": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "config" + }, + "3576": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.container" + }, + "3577": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.config" + }, + "3578": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.calculateVariantPrice" + }, + "3579": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.calculateVariantPrice" + }, + "3580": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "data" + }, + "3581": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type" + }, + "3582": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.variantId" + }, + "3584": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.quantity" + }, + "3585": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "context" + }, + "3586": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.onVariantsPricesUpdate" + }, + "3587": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.onVariantsPricesUpdate" + }, + "3588": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "variantIds" + }, + "3589": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.manager_" + }, + "3590": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.transactionManager_" + }, + "3591": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "3592": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "3593": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__container__" + }, + "3594": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__configModule__" + }, + "3595": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + }, + "3596": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "3597": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "3598": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "3599": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "3600": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "3601": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "err" + }, "3602": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, "3603": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.code" }, "3604": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "3605": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "3606": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "TResult" }, "3607": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "TError" }, "3608": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "work" }, "3609": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "maybeErrorHandlerOrDontFail" + "qualifiedName": "__type" }, "3610": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -132791,587 +135600,547 @@ }, "3611": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "transactionManager" }, "3612": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "isolationOrErrorHandler" }, "3613": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "PriceSelectionContext" + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" }, "3614": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, "3615": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.cart_id" - }, - "3616": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.customer_id" - }, - "3617": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.region_id" - }, - "3618": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.quantity" - }, - "3619": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.currency_code" - }, - "3620": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.include_discount_prices" - }, - "3621": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.tax_rates" - }, - "3622": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.ignore_cache" - }, - "3623": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "PriceType" - }, - "3624": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__object" - }, - "3625": { - "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "SALE" - }, - "3626": { - "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "OVERRIDE" - }, - "3627": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "DEFAULT" - }, - "3628": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "PriceType" - }, - "3629": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "PriceSelectionResult" - }, - "3630": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type" - }, - "3631": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.originalPrice" - }, - "3632": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.originalPriceIncludesTax" - }, - "3633": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.calculatedPrice" - }, - "3634": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.calculatedPriceIncludesTax" - }, - "3635": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.calculatedPriceType" - }, - "3636": { - "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", - "qualifiedName": "__type.prices" - }, - "3637": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "ITaxCalculationStrategy" - }, - "3638": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "ITaxCalculationStrategy.calculate" - }, - "3639": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "ITaxCalculationStrategy.calculate" - }, - "3640": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "items" - }, - "3641": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "taxLines" - }, - "3642": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "calculationContext" - }, - "3643": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "AbstractTaxCalculationStrategy" - }, - "3644": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "AbstractTaxCalculationStrategy._isTaxCalculationStrategy" - }, - "3645": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "AbstractTaxCalculationStrategy.isTaxCalculationStrategy" - }, - "3646": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "AbstractTaxCalculationStrategy.isTaxCalculationStrategy" - }, - "3647": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "object" - }, - "3648": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__constructor" - }, - "3649": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "AbstractTaxCalculationStrategy" - }, - "3650": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__container__" - }, - "3651": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__configModule__" - }, - "3652": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__moduleDeclaration__" - }, - "3653": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "AbstractTaxCalculationStrategy.calculate" - }, - "3654": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "AbstractTaxCalculationStrategy.calculate" - }, - "3655": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "items" - }, - "3656": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "taxLines" - }, - "3657": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", - "qualifiedName": "calculationContext" - }, - "3658": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.manager_" - }, - "3659": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.transactionManager_" - }, - "3660": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" - }, - "3661": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" - }, - "3662": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__container__" - }, - "3663": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__configModule__" - }, - "3664": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__moduleDeclaration__" - }, - "3665": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" - }, - "3666": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" - }, - "3667": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" - }, - "3668": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" - }, - "3669": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" - }, - "3670": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "err" - }, - "3671": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3672": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type.code" - }, - "3673": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" - }, - "3674": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" - }, - "3675": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TResult" - }, - "3676": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TError" - }, - "3677": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "work" - }, - "3678": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3679": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3680": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" - }, - "3681": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" - }, - "3682": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3683": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" - }, - "3684": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3685": { + "3616": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "maybeErrorHandlerOrDontFail" }, - "3686": { + "3617": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3687": { + "3618": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3688": { + "3619": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "error" }, - "3689": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "ShippingTaxCalculationLine" + "3620": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "PriceSelectionContext" }, - "3690": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type" + "3621": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.cart_id" }, - "3691": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type.shipping_method" + "3622": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.customer_id" }, - "3692": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type.rates" + "3623": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.region_id" }, - "3693": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "ItemTaxCalculationLine" + "3624": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.quantity" }, - "3694": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type" + "3625": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.currency_code" }, - "3695": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type.item" + "3626": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.include_discount_prices" }, - "3696": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type.rates" + "3627": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.tax_rates" }, - "3697": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "TaxCalculationContext" + "3628": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.ignore_cache" }, - "3698": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type" + "3629": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "PriceType" }, - "3699": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type.shipping_address" + "3630": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__object" }, - "3700": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type.customer" + "3631": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "SALE" }, - "3701": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type.region" + "3632": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "OVERRIDE" }, - "3702": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type.is_return" + "3633": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "DEFAULT" }, - "3703": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type.shipping_methods" + "3634": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "PriceType" }, - "3704": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "__type.allocation_map" + "3635": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "PriceSelectionResult" }, - "3705": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "ITaxService" + "3636": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.originalPrice" }, - "3706": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "ITaxService.getTaxLines" + "3637": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.originalPriceIncludesTax" }, - "3707": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "ITaxService.getTaxLines" + "3638": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.calculatedPrice" }, - "3708": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "itemLines" + "3639": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.calculatedPriceIncludesTax" }, - "3709": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "shippingLines" + "3640": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.calculatedPriceType" }, - "3710": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "context" + "3641": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.prices" }, - "3711": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "AbstractTaxService" + "3642": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "ITaxCalculationStrategy" }, - "3712": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "AbstractTaxService._isTaxService" + "3643": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "ITaxCalculationStrategy.calculate" }, - "3713": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "AbstractTaxService.identifier" + "3644": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "ITaxCalculationStrategy.calculate" }, - "3714": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "AbstractTaxService.isTaxService" + "3645": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "items" }, - "3715": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "AbstractTaxService.isTaxService" + "3646": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "taxLines" }, - "3716": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "object" + "3647": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "calculationContext" }, - "3717": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__constructor" + "3648": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy" }, - "3718": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "AbstractTaxService" + "3653": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy.__constructor" }, - "3719": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__container__" + "3654": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy" }, - "3720": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__configModule__" + "3655": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "container" }, - "3721": { - "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__moduleDeclaration__" + "3656": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "config" }, - "3722": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "AbstractTaxService.getIdentifier" + "3657": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy.container" }, - "3723": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "AbstractTaxService.getIdentifier" + "3658": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy.config" }, - "3724": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "AbstractTaxService.getTaxLines" + "3659": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy.calculate" }, - "3725": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "AbstractTaxService.getTaxLines" + "3660": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy.calculate" }, - "3726": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "itemLines" + "3661": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "items" }, - "3727": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "shippingLines" + "3662": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "taxLines" }, - "3728": { - "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", - "qualifiedName": "context" + "3663": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "calculationContext" }, - "3729": { + "3664": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.manager_" }, - "3730": { + "3665": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.transactionManager_" }, - "3731": { + "3666": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3732": { + "3667": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.activeManager_" }, - "3733": { + "3668": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__container__" }, - "3734": { + "3669": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__configModule__" }, - "3735": { + "3670": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, - "3736": { + "3671": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3737": { + "3672": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.withTransaction" }, - "3738": { + "3673": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "transactionManager" }, - "3739": { + "3674": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3740": { + "3675": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, - "3741": { + "3676": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "err" }, - "3742": { + "3677": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, - "3743": { + "3678": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type.code" }, - "3744": { + "3679": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3745": { + "3680": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TransactionBaseService.atomicPhase_" }, - "3746": { + "3681": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TResult" }, - "3747": { + "3682": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "TError" }, - "3748": { + "3683": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "work" }, + "3684": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3685": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3686": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "3687": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "isolationOrErrorHandler" + }, + "3688": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3689": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3690": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "3691": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "maybeErrorHandlerOrDontFail" + }, + "3692": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3693": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3694": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "3695": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "ShippingTaxCalculationLine" + }, + "3696": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type" + }, + "3697": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.shipping_method" + }, + "3698": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.rates" + }, + "3699": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "ItemTaxCalculationLine" + }, + "3700": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type" + }, + "3701": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.item" + }, + "3702": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.rates" + }, + "3703": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "TaxCalculationContext" + }, + "3704": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type" + }, + "3705": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.shipping_address" + }, + "3706": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.customer" + }, + "3707": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.region" + }, + "3708": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.is_return" + }, + "3709": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.shipping_methods" + }, + "3710": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.allocation_map" + }, + "3711": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "ITaxService" + }, + "3712": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "ITaxService.getTaxLines" + }, + "3713": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "ITaxService.getTaxLines" + }, + "3714": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "itemLines" + }, + "3715": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "shippingLines" + }, + "3716": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "context" + }, + "3717": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService" + }, + "3719": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService.identifier" + }, + "3723": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService.__constructor" + }, + "3724": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService" + }, + "3725": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "container" + }, + "3726": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "config" + }, + "3727": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService.container" + }, + "3728": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService.config" + }, + "3731": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService.getTaxLines" + }, + "3732": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService.getTaxLines" + }, + "3733": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "itemLines" + }, + "3734": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "shippingLines" + }, + "3735": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "context" + }, + "3736": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.manager_" + }, + "3737": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.transactionManager_" + }, + "3738": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "3739": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "3740": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__container__" + }, + "3741": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__configModule__" + }, + "3742": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + }, + "3743": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "3744": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "3745": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "3746": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "3747": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "3748": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "err" + }, "3749": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", "qualifiedName": "__type" }, "3750": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.code" }, "3751": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "3752": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "3753": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "TResult" }, "3754": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "TError" }, "3755": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "work" }, "3756": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "maybeErrorHandlerOrDontFail" + "qualifiedName": "__type" }, "3757": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -133379,115 +136148,115 @@ }, "3758": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "transactionManager" }, "3759": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "isolationOrErrorHandler" }, "3760": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService" + "qualifiedName": "__type" }, "3761": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__constructor" + "qualifiedName": "__type" }, "3762": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService" + "qualifiedName": "error" }, "3763": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__container__" + "qualifiedName": "maybeErrorHandlerOrDontFail" }, "3764": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__configModule__" + "qualifiedName": "__type" }, "3765": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__moduleDeclaration__" + "qualifiedName": "__type" }, "3766": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.manager_" + "qualifiedName": "error" }, "3767": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.transactionManager_" + "qualifiedName": "TransactionBaseService" }, "3768": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" + "qualifiedName": "TransactionBaseService.__constructor" }, "3769": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.activeManager_" + "qualifiedName": "TransactionBaseService" }, "3770": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__container__" + "qualifiedName": "__container__" }, "3771": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__configModule__" + "qualifiedName": "__configModule__" }, "3772": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + "qualifiedName": "__moduleDeclaration__" }, "3773": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" + "qualifiedName": "TransactionBaseService.manager_" }, "3774": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.withTransaction" + "qualifiedName": "TransactionBaseService.transactionManager_" }, "3775": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TransactionBaseService.activeManager_" }, "3776": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + "qualifiedName": "TransactionBaseService.activeManager_" }, "3777": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + "qualifiedName": "TransactionBaseService.__container__" }, "3778": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "err" + "qualifiedName": "TransactionBaseService.__configModule__" }, "3779": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" }, "3780": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type.code" + "qualifiedName": "TransactionBaseService.withTransaction" }, "3781": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" + "qualifiedName": "TransactionBaseService.withTransaction" }, "3782": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TransactionBaseService.atomicPhase_" + "qualifiedName": "transactionManager" }, "3783": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TResult" + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, "3784": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "TError" + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" }, "3785": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "work" + "qualifiedName": "err" }, "3786": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -133495,31 +136264,31 @@ }, "3787": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.code" }, "3788": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "transactionManager" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "3789": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "isolationOrErrorHandler" + "qualifiedName": "TransactionBaseService.atomicPhase_" }, "3790": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "TResult" }, "3791": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "TError" }, "3792": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "work" }, "3793": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "maybeErrorHandlerOrDontFail" + "qualifiedName": "__type" }, "3794": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", @@ -133527,687 +136296,687 @@ }, "3795": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "__type" + "qualifiedName": "transactionManager" }, "3796": { "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", - "qualifiedName": "error" + "qualifiedName": "isolationOrErrorHandler" }, "3797": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3798": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3799": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "3800": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "maybeErrorHandlerOrDontFail" + }, + "3801": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3802": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "3803": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "3804": { "sourceFileName": "../../../packages/medusa/src/joiner-config.ts", "qualifiedName": "joinerConfig" }, - "3798": { + "3805": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "BatchJobStatus" }, - "3799": { + "3806": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "BatchJobStatus.CREATED" }, - "3800": { + "3807": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "BatchJobStatus.PRE_PROCESSED" }, - "3801": { + "3808": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "BatchJobStatus.CONFIRMED" }, - "3802": { + "3809": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "BatchJobStatus.PROCESSING" }, - "3803": { + "3810": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "BatchJobStatus.COMPLETED" }, - "3804": { + "3811": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "BatchJobStatus.CANCELED" }, - "3805": { + "3812": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "BatchJobStatus.FAILED" }, - "3806": { + "3813": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "BatchJobUpdateProps" }, - "3807": { + "3814": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "CreateBatchJobInput" }, - "3808": { - "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "__type" - }, - "3809": { - "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "__type.type" - }, - "3810": { - "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "__type.context" - }, - "3811": { - "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "__type.dry_run" - }, - "3812": { - "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "BatchJobResultError" - }, - "3813": { - "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "__type" - }, - "3814": { - "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "__type.message" - }, "3815": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "__type.code" + "qualifiedName": "__type" }, "3816": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "__type.__index" + "qualifiedName": "__type.type" + }, + "3817": { + "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", + "qualifiedName": "__type.context" }, "3818": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "BatchJobResultStatDescriptor" + "qualifiedName": "__type.dry_run" }, "3819": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "__type" + "qualifiedName": "BatchJobResultError" }, "3820": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "__type.key" + "qualifiedName": "__type" }, "3821": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "__type.name" + "qualifiedName": "__type.message" }, "3822": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "__type.message" + "qualifiedName": "__type.code" }, "3823": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "FilterableBatchJobProps" + "qualifiedName": "__type.__index" + }, + "3825": { + "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", + "qualifiedName": "BatchJobResultStatDescriptor" }, "3826": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "FilterableBatchJobProps.id" + "qualifiedName": "__type" }, "3827": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "FilterableBatchJobProps.status" + "qualifiedName": "__type.key" }, "3828": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "FilterableBatchJobProps.type" + "qualifiedName": "__type.name" }, "3829": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", - "qualifiedName": "FilterableBatchJobProps.created_by" + "qualifiedName": "__type.message" }, "3830": { + "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", + "qualifiedName": "FilterableBatchJobProps" + }, + "3833": { + "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", + "qualifiedName": "FilterableBatchJobProps.id" + }, + "3834": { + "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", + "qualifiedName": "FilterableBatchJobProps.status" + }, + "3835": { + "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", + "qualifiedName": "FilterableBatchJobProps.type" + }, + "3836": { + "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", + "qualifiedName": "FilterableBatchJobProps.created_by" + }, + "3837": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "FilterableBatchJobProps.created_at" }, - "3831": { + "3838": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "FilterableBatchJobProps.updated_at" }, - "3832": { + "3839": { "sourceFileName": "../../../packages/medusa/src/types/batch-job.ts", "qualifiedName": "BatchJobCreateProps" }, - "3833": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "extendedFindParamsMixin" - }, - "3834": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "extendedFindParamsMixin" - }, - "3835": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__0" - }, - "3836": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type" - }, - "3837": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.limit" - }, - "3838": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.offset" - }, - "3839": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "WithRequiredProperty" - }, "3840": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "T" + "qualifiedName": "extendedFindParamsMixin" }, "3841": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "K" + "qualifiedName": "extendedFindParamsMixin" }, "3842": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "PartialPick" + "qualifiedName": "__0" }, "3843": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "T" + "qualifiedName": "__type" }, "3844": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "K" + "qualifiedName": "__type.limit" }, "3845": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "Writable" + "qualifiedName": "__type.offset" }, "3846": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "T" + "qualifiedName": "WithRequiredProperty" }, "3847": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "FindConfig" + "qualifiedName": "T" }, "3848": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "FindConfig.select" + "qualifiedName": "K" }, "3849": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "FindConfig.skip" + "qualifiedName": "PartialPick" }, "3850": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "FindConfig.take" + "qualifiedName": "T" }, "3851": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "FindConfig.relations" + "qualifiedName": "K" }, "3852": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "FindConfig.order" + "qualifiedName": "Writable" }, "3853": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type" + "qualifiedName": "T" }, "3854": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.__index" + "qualifiedName": "FindConfig" + }, + "3855": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "FindConfig.select" }, "3856": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "FindConfig.Entity" + "qualifiedName": "FindConfig.skip" }, "3857": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "ExtendedFindConfig" + "qualifiedName": "FindConfig.take" }, "3858": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type" + "qualifiedName": "FindConfig.relations" }, "3859": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.select" + "qualifiedName": "FindConfig.order" }, "3860": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.relations" + "qualifiedName": "__type" }, "3861": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.where" - }, - "3862": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.order" + "qualifiedName": "__type.__index" }, "3863": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.skip" + "qualifiedName": "FindConfig.Entity" }, "3864": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.take" + "qualifiedName": "ExtendedFindConfig" }, "3865": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "TEntity" + "qualifiedName": "__type" }, "3866": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "QuerySelector" + "qualifiedName": "__type.select" }, "3867": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.relations" }, "3868": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.q" + "qualifiedName": "__type.where" }, "3869": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "TEntity" + "qualifiedName": "__type.order" }, "3870": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "TreeQuerySelector" + "qualifiedName": "__type.skip" }, "3871": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.take" }, "3872": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.include_descendants_tree" + "qualifiedName": "TEntity" }, "3873": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "TEntity" + "qualifiedName": "QuerySelector" }, "3874": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "Selector" + "qualifiedName": "__type" }, "3875": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "TEntity" + "qualifiedName": "__type.q" }, "3876": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "TotalField" + "qualifiedName": "TEntity" }, "3877": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "CustomFindOptions" + "qualifiedName": "TreeQuerySelector" }, "3878": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "CustomFindOptions.select" + "qualifiedName": "__type" }, "3879": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "CustomFindOptions.where" + "qualifiedName": "__type.include_descendants_tree" }, "3880": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "CustomFindOptions.order" + "qualifiedName": "TEntity" }, "3881": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "CustomFindOptions.skip" + "qualifiedName": "Selector" }, "3882": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "CustomFindOptions.take" + "qualifiedName": "TEntity" }, "3883": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "CustomFindOptions.TModel" + "qualifiedName": "TotalField" }, "3884": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "CustomFindOptions.InKeys" + "qualifiedName": "CustomFindOptions" }, "3885": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "QueryConfig" + "qualifiedName": "CustomFindOptions.select" }, "3886": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type" + "qualifiedName": "CustomFindOptions.where" }, "3887": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.defaultFields" + "qualifiedName": "CustomFindOptions.order" }, "3888": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.defaultRelations" + "qualifiedName": "CustomFindOptions.skip" }, "3889": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.allowedFields" + "qualifiedName": "CustomFindOptions.take" }, "3890": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.allowedRelations" + "qualifiedName": "CustomFindOptions.TModel" }, "3891": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.defaultLimit" + "qualifiedName": "CustomFindOptions.InKeys" }, "3892": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.isList" + "qualifiedName": "QueryConfig" }, "3893": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "TEntity" + "qualifiedName": "__type" }, "3894": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "RequestQueryFields" + "qualifiedName": "__type.defaultFields" }, "3895": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.expand" + "qualifiedName": "__type.defaultRelations" }, "3896": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.fields" + "qualifiedName": "__type.allowedFields" }, "3897": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.offset" + "qualifiedName": "__type.allowedRelations" }, "3898": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.limit" + "qualifiedName": "__type.defaultLimit" }, "3899": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.order" + "qualifiedName": "__type.isList" }, "3900": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "PaginatedResponse" + "qualifiedName": "TEntity" }, "3901": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.limit" + "qualifiedName": "RequestQueryFields" }, "3902": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.offset" + "qualifiedName": "__type.expand" }, "3903": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.count" + "qualifiedName": "__type.fields" }, "3904": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "DeleteResponse" + "qualifiedName": "__type.offset" }, "3905": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.id" + "qualifiedName": "__type.limit" }, "3906": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.object" + "qualifiedName": "__type.order" }, "3907": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "__type.deleted" + "qualifiedName": "PaginatedResponse" }, "3908": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "EmptyQueryParams" + "qualifiedName": "__type.limit" + }, + "3909": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "__type.offset" + }, + "3910": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "__type.count" }, "3911": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "DateComparisonOperator" + "qualifiedName": "DeleteResponse" + }, + "3912": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "__type.id" + }, + "3913": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "__type.object" }, "3914": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "DateComparisonOperator.lt" + "qualifiedName": "__type.deleted" }, "3915": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "DateComparisonOperator.gt" - }, - "3916": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "DateComparisonOperator.gte" - }, - "3917": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "DateComparisonOperator.lte" + "qualifiedName": "EmptyQueryParams" }, "3918": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "StringComparisonOperator" + "qualifiedName": "DateComparisonOperator" }, "3921": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "StringComparisonOperator.lt" + "qualifiedName": "DateComparisonOperator.lt" }, "3922": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "StringComparisonOperator.gt" + "qualifiedName": "DateComparisonOperator.gt" }, "3923": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "StringComparisonOperator.gte" + "qualifiedName": "DateComparisonOperator.gte" }, "3924": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "StringComparisonOperator.lte" + "qualifiedName": "DateComparisonOperator.lte" }, "3925": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "StringComparisonOperator.contains" - }, - "3926": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "StringComparisonOperator.starts_with" - }, - "3927": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "StringComparisonOperator.ends_with" + "qualifiedName": "StringComparisonOperator" }, "3928": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "NumericalComparisonOperator" + "qualifiedName": "StringComparisonOperator.lt" + }, + "3929": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "StringComparisonOperator.gt" + }, + "3930": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "StringComparisonOperator.gte" }, "3931": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "NumericalComparisonOperator.lt" + "qualifiedName": "StringComparisonOperator.lte" }, "3932": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "NumericalComparisonOperator.gt" + "qualifiedName": "StringComparisonOperator.contains" }, "3933": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "NumericalComparisonOperator.gte" + "qualifiedName": "StringComparisonOperator.starts_with" }, "3934": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "NumericalComparisonOperator.lte" + "qualifiedName": "StringComparisonOperator.ends_with" }, "3935": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressPayload" + "qualifiedName": "NumericalComparisonOperator" }, "3938": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressPayload.first_name" + "qualifiedName": "NumericalComparisonOperator.lt" }, "3939": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressPayload.last_name" + "qualifiedName": "NumericalComparisonOperator.gt" }, "3940": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressPayload.phone" + "qualifiedName": "NumericalComparisonOperator.gte" }, "3941": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressPayload.metadata" + "qualifiedName": "NumericalComparisonOperator.lte" }, "3942": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressPayload.company" - }, - "3943": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressPayload.address_1" - }, - "3944": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressPayload.address_2" + "qualifiedName": "AddressPayload" }, "3945": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressPayload.city" + "qualifiedName": "AddressPayload.first_name" }, "3946": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressPayload.country_code" + "qualifiedName": "AddressPayload.last_name" }, "3947": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressPayload.province" + "qualifiedName": "AddressPayload.phone" }, "3948": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressPayload.postal_code" + "qualifiedName": "AddressPayload.metadata" }, "3949": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressCreatePayload" + "qualifiedName": "AddressPayload.company" + }, + "3950": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "AddressPayload.address_1" + }, + "3951": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "AddressPayload.address_2" }, "3952": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressCreatePayload.first_name" + "qualifiedName": "AddressPayload.city" }, "3953": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressCreatePayload.last_name" + "qualifiedName": "AddressPayload.country_code" }, "3954": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressCreatePayload.phone" + "qualifiedName": "AddressPayload.province" }, "3955": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressCreatePayload.metadata" + "qualifiedName": "AddressPayload.postal_code" }, "3956": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressCreatePayload.company" - }, - "3957": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressCreatePayload.address_1" - }, - "3958": { - "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressCreatePayload.address_2" + "qualifiedName": "AddressCreatePayload" }, "3959": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressCreatePayload.city" + "qualifiedName": "AddressCreatePayload.first_name" }, "3960": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressCreatePayload.country_code" + "qualifiedName": "AddressCreatePayload.last_name" }, "3961": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressCreatePayload.province" + "qualifiedName": "AddressCreatePayload.phone" }, "3962": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "AddressCreatePayload.postal_code" + "qualifiedName": "AddressCreatePayload.metadata" }, "3963": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "FindParams" + "qualifiedName": "AddressCreatePayload.company" + }, + "3964": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "AddressCreatePayload.address_1" + }, + "3965": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "AddressCreatePayload.address_2" }, "3966": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "FindParams.expand" + "qualifiedName": "AddressCreatePayload.city" }, "3967": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", - "qualifiedName": "FindParams.fields" + "qualifiedName": "AddressCreatePayload.country_code" }, "3968": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "AddressCreatePayload.province" + }, + "3969": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "AddressCreatePayload.postal_code" + }, + "3970": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "FindParams" + }, + "3973": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "FindParams.expand" + }, + "3974": { + "sourceFileName": "../../../packages/medusa/src/types/common.ts", + "qualifiedName": "FindParams.fields" + }, + "3975": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", "qualifiedName": "FindPaginationParams" }, - "3971": { + "3978": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", "qualifiedName": "FindPaginationParams.offset" }, - "3972": { + "3979": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", "qualifiedName": "FindPaginationParams.limit" }, - "3973": { + "3980": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", "qualifiedName": "ExtendedRequest" }, - "3974": { - "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" - }, - "3975": { - "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.resource" - }, - "3976": { - "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "TEntity" - }, - "3977": { - "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "ClassConstructor" - }, - "3978": { - "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" - }, - "3979": { - "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" - }, - "3980": { - "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "args" - }, "3981": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "T" + "qualifiedName": "__type" }, "3982": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "MedusaContainer" + "qualifiedName": "__type.resource" }, "3983": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "Logger" + "qualifiedName": "TEntity" }, "3984": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "ClassConstructor" }, "3985": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.panic" + "qualifiedName": "__type" }, "3986": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", @@ -134215,19 +136984,19 @@ }, "3987": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "args" }, "3988": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "data" + "qualifiedName": "T" }, "3989": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.shouldLog" + "qualifiedName": "MedusaContainer" }, "3990": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "Logger" }, "3991": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", @@ -134235,11 +137004,11 @@ }, "3992": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "level" + "qualifiedName": "__type.panic" }, "3993": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.setLogLevel" + "qualifiedName": "__type" }, "3994": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", @@ -134247,15 +137016,15 @@ }, "3995": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "data" }, "3996": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "level" + "qualifiedName": "__type.shouldLog" }, "3997": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.unsetLogLevel" + "qualifiedName": "__type" }, "3998": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", @@ -134263,11 +137032,11 @@ }, "3999": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "level" }, "4000": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.activity" + "qualifiedName": "__type.setLogLevel" }, "4001": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", @@ -134279,15 +137048,15 @@ }, "4003": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "message" + "qualifiedName": "level" }, "4004": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "config" + "qualifiedName": "__type.unsetLogLevel" }, "4005": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.progress" + "qualifiedName": "__type" }, "4006": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", @@ -134295,111 +137064,111 @@ }, "4007": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.activity" }, "4008": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "activityId" + "qualifiedName": "__type" }, "4009": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "message" + "qualifiedName": "__type" }, "4010": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.error" + "qualifiedName": "message" }, "4011": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "config" }, "4012": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.progress" }, "4013": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "messageOrError" + "qualifiedName": "__type" }, "4014": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "error" + "qualifiedName": "__type" }, "4015": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.failure" + "qualifiedName": "activityId" }, "4016": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "message" }, "4017": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.error" }, "4018": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "activityId" + "qualifiedName": "__type" }, "4019": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "message" + "qualifiedName": "__type" }, "4020": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.success" + "qualifiedName": "messageOrError" }, "4021": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "error" }, "4022": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.failure" }, "4023": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "activityId" + "qualifiedName": "__type" }, "4024": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "message" + "qualifiedName": "__type" }, "4025": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.debug" + "qualifiedName": "activityId" }, "4026": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "message" }, "4027": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.success" }, "4028": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "message" + "qualifiedName": "__type" }, "4029": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.info" + "qualifiedName": "__type" }, "4030": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "activityId" }, "4031": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "message" }, "4032": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "message" + "qualifiedName": "__type.debug" }, "4033": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.warn" + "qualifiedName": "__type" }, "4034": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", @@ -134407,15 +137176,15 @@ }, "4035": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "message" }, "4036": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "message" + "qualifiedName": "__type.info" }, "4037": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type.log" + "qualifiedName": "__type" }, "4038": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", @@ -134423,15 +137192,15 @@ }, "4039": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "message" }, "4040": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "args" + "qualifiedName": "__type.warn" }, "4041": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "Constructor" + "qualifiedName": "__type" }, "4042": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", @@ -134439,235 +137208,235 @@ }, "4043": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "__type" + "qualifiedName": "message" }, "4044": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "args" + "qualifiedName": "__type.log" }, "4045": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "T" + "qualifiedName": "__type" }, "4046": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", - "qualifiedName": "ConfigModule" - }, - "4047": { - "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", - "qualifiedName": "MiddlewareFunction" - }, - "4048": { - "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "__type" }, + "4047": { + "sourceFileName": "../../../packages/medusa/src/types/global.ts", + "qualifiedName": "args" + }, + "4048": { + "sourceFileName": "../../../packages/medusa/src/types/global.ts", + "qualifiedName": "Constructor" + }, "4049": { - "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", + "sourceFileName": "../../../packages/medusa/src/types/global.ts", "qualifiedName": "__type" }, "4050": { - "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", - "qualifiedName": "args" - }, - "4051": { - "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", - "qualifiedName": "MiddlewareRoute" - }, - "4052": { - "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", + "sourceFileName": "../../../packages/medusa/src/types/global.ts", "qualifiedName": "__type" }, + "4051": { + "sourceFileName": "../../../packages/medusa/src/types/global.ts", + "qualifiedName": "args" + }, + "4052": { + "sourceFileName": "../../../packages/medusa/src/types/global.ts", + "qualifiedName": "T" + }, "4053": { - "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", - "qualifiedName": "__type.method" + "sourceFileName": "../../../packages/medusa/src/types/global.ts", + "qualifiedName": "ConfigModule" }, "4054": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", - "qualifiedName": "__type.matcher" + "qualifiedName": "MiddlewareFunction" }, "4055": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", - "qualifiedName": "__type.bodyParser" + "qualifiedName": "__type" }, "4056": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", - "qualifiedName": "__type.middlewares" + "qualifiedName": "__type" }, "4057": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", - "qualifiedName": "MiddlewaresConfig" + "qualifiedName": "args" }, "4058": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", - "qualifiedName": "__type" + "qualifiedName": "MiddlewareRoute" }, "4059": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", - "qualifiedName": "__type.errorHandler" + "qualifiedName": "__type" }, "4060": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", - "qualifiedName": "__type.routes" + "qualifiedName": "__type.method" }, "4061": { + "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", + "qualifiedName": "__type.matcher" + }, + "4062": { + "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", + "qualifiedName": "__type.bodyParser" + }, + "4063": { + "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", + "qualifiedName": "__type.middlewares" + }, + "4064": { + "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", + "qualifiedName": "MiddlewaresConfig" + }, + "4065": { + "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", + "qualifiedName": "__type" + }, + "4066": { + "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", + "qualifiedName": "__type.errorHandler" + }, + "4067": { + "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", + "qualifiedName": "__type.routes" + }, + "4068": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "PriceListType" }, - "4062": { + "4069": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "PriceListType.SALE" }, - "4063": { + "4070": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "PriceListType.OVERRIDE" }, - "4064": { + "4071": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "PriceListStatus" }, - "4065": { + "4072": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "PriceListStatus.ACTIVE" }, - "4066": { + "4073": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "PriceListStatus.DRAFT" }, - "4067": { + "4074": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "FilterablePriceListProps" }, - "4070": { + "4077": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "FilterablePriceListProps.id" }, - "4071": { + "4078": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "FilterablePriceListProps.q" }, - "4072": { + "4079": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "FilterablePriceListProps.status" }, - "4073": { + "4080": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "FilterablePriceListProps.name" }, - "4074": { + "4081": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "FilterablePriceListProps.customer_groups" }, - "4075": { + "4082": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "FilterablePriceListProps.description" }, - "4076": { + "4083": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "FilterablePriceListProps.type" }, - "4077": { + "4084": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "FilterablePriceListProps.created_at" }, - "4078": { + "4085": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "FilterablePriceListProps.updated_at" }, - "4079": { + "4086": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "FilterablePriceListProps.deleted_at" }, - "4080": { + "4087": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesUpdateReq" }, - "4083": { + "4090": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesUpdateReq.id" }, - "4084": { + "4091": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesUpdateReq.region_id" }, - "4085": { + "4092": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesUpdateReq.currency_code" }, - "4086": { + "4093": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesUpdateReq.variant_id" }, - "4087": { + "4094": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesUpdateReq.amount" }, - "4088": { + "4095": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesUpdateReq.min_quantity" }, - "4089": { + "4096": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesUpdateReq.max_quantity" }, - "4090": { + "4097": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesCreateReq" }, - "4093": { + "4100": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesCreateReq.region_id" }, - "4094": { + "4101": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesCreateReq.currency_code" }, - "4095": { + "4102": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesCreateReq.amount" }, - "4096": { + "4103": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesCreateReq.variant_id" }, - "4097": { + "4104": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesCreateReq.min_quantity" }, - "4098": { + "4105": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", "qualifiedName": "AdminPriceListPricesCreateReq.max_quantity" }, - "4099": { - "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "CreatePriceListInput" - }, - "4100": { - "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type" - }, - "4101": { - "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.name" - }, - "4102": { - "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.description" - }, - "4103": { - "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.type" - }, - "4104": { - "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.status" - }, - "4105": { - "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.prices" - }, "4106": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.customer_groups" + "qualifiedName": "CreatePriceListInput" }, "4107": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", @@ -134675,87 +137444,87 @@ }, "4108": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.id" + "qualifiedName": "__type.name" }, "4109": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.starts_at" + "qualifiedName": "__type.description" }, "4110": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.ends_at" + "qualifiedName": "__type.type" }, "4111": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.includes_tax" + "qualifiedName": "__type.status" }, "4112": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "UpdatePriceListInput" + "qualifiedName": "__type.prices" }, "4113": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.customer_groups" }, "4114": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.prices" + "qualifiedName": "__type" }, "4115": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.customer_groups" + "qualifiedName": "__type.id" }, "4116": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.starts_at" }, "4117": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.id" + "qualifiedName": "__type.ends_at" }, "4118": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "PriceListPriceUpdateInput" + "qualifiedName": "__type.includes_tax" }, "4119": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type" + "qualifiedName": "UpdatePriceListInput" }, "4120": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.id" + "qualifiedName": "__type" }, "4121": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.variant_id" + "qualifiedName": "__type.prices" }, "4122": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.region_id" + "qualifiedName": "__type.customer_groups" }, "4123": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.currency_code" + "qualifiedName": "__type" }, "4124": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.amount" + "qualifiedName": "__type.id" }, "4125": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.min_quantity" + "qualifiedName": "PriceListPriceUpdateInput" }, "4126": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.max_quantity" + "qualifiedName": "__type" }, "4127": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "PriceListPriceCreateInput" + "qualifiedName": "__type.id" }, "4128": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.variant_id" }, "4129": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", @@ -134767,4105 +137536,4021 @@ }, "4131": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.variant_id" + "qualifiedName": "__type.amount" }, "4132": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.amount" + "qualifiedName": "__type.min_quantity" }, "4133": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.min_quantity" + "qualifiedName": "__type.max_quantity" }, "4134": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.max_quantity" + "qualifiedName": "PriceListPriceCreateInput" }, "4135": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "PriceListLoadConfig" + "qualifiedName": "__type" }, "4136": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.region_id" }, "4137": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.include_discount_prices" + "qualifiedName": "__type.currency_code" }, "4138": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.customer_id" + "qualifiedName": "__type.variant_id" }, "4139": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.cart_id" + "qualifiedName": "__type.amount" }, "4140": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.region_id" + "qualifiedName": "__type.min_quantity" }, "4141": { "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", - "qualifiedName": "__type.currency_code" + "qualifiedName": "__type.max_quantity" }, "4142": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "PriceListLoadConfig" + }, + "4143": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "__type" + }, + "4144": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "__type.include_discount_prices" + }, + "4145": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "__type.customer_id" + }, + "4146": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "__type.cart_id" + }, + "4147": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "__type.region_id" + }, + "4148": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "__type.currency_code" + }, + "4149": { "sourceFileName": "../../../packages/medusa/src/types/routing.ts", "qualifiedName": "MedusaRequest" }, - "4143": { + "4150": { "sourceFileName": "../../../packages/medusa/src/types/routing.ts", "qualifiedName": "MedusaRequest.user" }, - "4144": { + "4151": { "sourceFileName": "../../../packages/medusa/src/types/routing.ts", "qualifiedName": "MedusaRequest.scope" }, - "4145": { + "4152": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", "qualifiedName": "__global.Express.Request.validatedQuery" }, - "4146": { + "4153": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", "qualifiedName": "__global.Express.Request.validatedBody" }, - "4147": { + "4154": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", "qualifiedName": "__global.Express.Request.listConfig" }, - "4148": { + "4155": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", "qualifiedName": "__global.Express.Request.retrieveConfig" }, - "4149": { + "4156": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", "qualifiedName": "__global.Express.Request.filterableFields" }, - "4150": { + "4157": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", "qualifiedName": "__global.Express.Request.allowedProperties" }, - "4151": { + "4158": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", "qualifiedName": "__global.Express.Request.includes" }, - "4152": { + "4159": { "sourceFileName": "../../../packages/medusa/src/types/global.ts", "qualifiedName": "__global.Express.Request.errors" }, - "4153": { + "4160": { "sourceFileName": "../../../packages/medusa/src/types/routing.ts", "qualifiedName": "MedusaResponse" }, - "4154": { + "4161": { "sourceFileName": "../../../packages/medusa/src/types/routing.ts", "qualifiedName": "MedusaNextFunction" }, - "4155": { + "4162": { "sourceFileName": "../../../packages/medusa/src/types/routing.ts", "qualifiedName": "MedusaRequestHandler" }, - "4156": { + "4163": { "sourceFileName": "../../../packages/medusa/src/types/routing.ts", "qualifiedName": "__type" }, - "4157": { + "4164": { "sourceFileName": "../../../packages/medusa/src/types/routing.ts", "qualifiedName": "__type" }, - "4158": { + "4165": { "sourceFileName": "../../../packages/medusa/src/types/routing.ts", "qualifiedName": "req" }, - "4159": { + "4166": { "sourceFileName": "../../../packages/medusa/src/types/routing.ts", "qualifiedName": "res" }, - "4160": { + "4167": { "sourceFileName": "../../../packages/medusa/src/types/routing.ts", "qualifiedName": "next" }, - "4161": { + "4168": { "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", "qualifiedName": "ScheduledJobConfig" }, - "4162": { - "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", - "qualifiedName": "__type" - }, - "4163": { - "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", - "qualifiedName": "__type.name" - }, - "4164": { - "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", - "qualifiedName": "__type.schedule" - }, - "4165": { - "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", - "qualifiedName": "__type.data" - }, - "4166": { - "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", - "qualifiedName": "T" - }, - "4167": { - "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", - "qualifiedName": "ScheduledJobArgs" - }, - "4168": { - "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", - "qualifiedName": "__type" - }, "4169": { "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", - "qualifiedName": "__type.container" + "qualifiedName": "__type" }, "4170": { "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", - "qualifiedName": "__type.data" + "qualifiedName": "__type.name" }, "4171": { "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", - "qualifiedName": "__type.pluginOptions" + "qualifiedName": "__type.schedule" }, "4172": { "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", - "qualifiedName": "T" + "qualifiedName": "__type.data" }, "4173": { - "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", - "qualifiedName": "SubscriberConfig" + "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", + "qualifiedName": "T" }, "4174": { - "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", + "qualifiedName": "ScheduledJobArgs" }, "4175": { - "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", - "qualifiedName": "__type.event" - }, - "4176": { - "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", - "qualifiedName": "__type.context" - }, - "4177": { - "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", - "qualifiedName": "SubscriberArgs" - }, - "4178": { - "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", + "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", "qualifiedName": "__type" }, - "4179": { - "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", + "4176": { + "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", + "qualifiedName": "__type.container" + }, + "4177": { + "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", "qualifiedName": "__type.data" }, + "4178": { + "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", + "qualifiedName": "__type.pluginOptions" + }, + "4179": { + "sourceFileName": "../../../packages/medusa/src/types/scheduled-jobs.ts", + "qualifiedName": "T" + }, "4180": { "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", - "qualifiedName": "__type.eventName" + "qualifiedName": "SubscriberConfig" }, "4181": { "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", - "qualifiedName": "__type.container" + "qualifiedName": "__type" }, "4182": { "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", - "qualifiedName": "__type.pluginOptions" + "qualifiedName": "__type.event" }, "4183": { "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", - "qualifiedName": "T" + "qualifiedName": "__type.context" }, "4184": { - "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", - "qualifiedName": "registerOverriddenValidators" + "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", + "qualifiedName": "SubscriberArgs" }, "4185": { - "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", - "qualifiedName": "registerOverriddenValidators" + "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", + "qualifiedName": "__type" }, "4186": { - "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", - "qualifiedName": "extendedValidator" + "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", + "qualifiedName": "__type.data" }, "4187": { - "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", - "qualifiedName": "validator" + "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", + "qualifiedName": "__type.eventName" }, "4188": { - "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", - "qualifiedName": "validator" + "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", + "qualifiedName": "__type.container" }, "4189": { - "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", - "qualifiedName": "T" + "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", + "qualifiedName": "__type.pluginOptions" }, "4190": { - "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", - "qualifiedName": "V" + "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", + "qualifiedName": "T" }, "4191": { "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", - "qualifiedName": "typedClass" + "qualifiedName": "registerOverriddenValidators" }, "4192": { "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", - "qualifiedName": "plain" + "qualifiedName": "registerOverriddenValidators" }, "4193": { "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", - "qualifiedName": "config" + "qualifiedName": "extendedValidator" }, "4194": { - "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "buildQuery" + "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", + "qualifiedName": "validator" }, "4195": { - "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "buildQuery" + "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", + "qualifiedName": "validator" }, "4196": { - "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "TWhereKeys" + "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", + "qualifiedName": "T" }, "4197": { - "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "TEntity" + "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", + "qualifiedName": "V" }, "4198": { - "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "selector" + "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", + "qualifiedName": "typedClass" }, "4199": { - "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "config" + "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", + "qualifiedName": "plain" }, "4200": { - "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "buildLegacyFieldsListFrom" + "sourceFileName": "../../../packages/medusa/src/utils/validator.ts", + "qualifiedName": "config" }, "4201": { "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "buildLegacyFieldsListFrom" + "qualifiedName": "buildQuery" }, "4202": { "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "TEntity" + "qualifiedName": "buildQuery" }, "4203": { "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "input" + "qualifiedName": "TWhereKeys" }, "4204": { "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "addOrderToSelect" + "qualifiedName": "TEntity" }, "4205": { "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "addOrderToSelect" + "qualifiedName": "selector" }, "4206": { "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "TEntity" + "qualifiedName": "config" }, "4207": { "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "order" + "qualifiedName": "buildLegacyFieldsListFrom" }, "4208": { "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "select" + "qualifiedName": "buildLegacyFieldsListFrom" }, "4209": { "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "nullableValue" + "qualifiedName": "TEntity" }, "4210": { "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "nullableValue" + "qualifiedName": "input" }, "4211": { "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", - "qualifiedName": "value" + "qualifiedName": "addOrderToSelect" }, "4212": { - "sourceFileName": "../../../packages/medusa/src/utils/calculate-price-tax-amount.ts", - "qualifiedName": "calculatePriceTaxAmount" + "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", + "qualifiedName": "addOrderToSelect" }, "4213": { + "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", + "qualifiedName": "TEntity" + }, + "4214": { + "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", + "qualifiedName": "order" + }, + "4215": { + "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", + "qualifiedName": "select" + }, + "4216": { + "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", + "qualifiedName": "nullableValue" + }, + "4217": { + "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", + "qualifiedName": "nullableValue" + }, + "4218": { + "sourceFileName": "../../../packages/medusa/src/utils/build-query.ts", + "qualifiedName": "value" + }, + "4219": { "sourceFileName": "../../../packages/medusa/src/utils/calculate-price-tax-amount.ts", "qualifiedName": "calculatePriceTaxAmount" }, - "4214": { + "4220": { + "sourceFileName": "../../../packages/medusa/src/utils/calculate-price-tax-amount.ts", + "qualifiedName": "calculatePriceTaxAmount" + }, + "4221": { "sourceFileName": "../../../packages/medusa/src/utils/calculate-price-tax-amount.ts", "qualifiedName": "__0" }, - "4215": { + "4222": { "sourceFileName": "../../../packages/medusa/src/utils/calculate-price-tax-amount.ts", "qualifiedName": "__type" }, - "4216": { + "4223": { "sourceFileName": "../../../packages/medusa/src/utils/calculate-price-tax-amount.ts", "qualifiedName": "__type.price" }, - "4217": { + "4224": { "sourceFileName": "../../../packages/medusa/src/utils/calculate-price-tax-amount.ts", "qualifiedName": "__type.includesTax" }, - "4218": { + "4225": { "sourceFileName": "../../../packages/medusa/src/utils/calculate-price-tax-amount.ts", "qualifiedName": "__type.taxRate" }, - "4219": { + "4226": { "sourceFileName": "../../../packages/medusa/src/utils/clean-response-data.ts", "qualifiedName": "cleanResponseData" }, - "4220": { + "4227": { "sourceFileName": "../../../packages/medusa/src/utils/clean-response-data.ts", "qualifiedName": "cleanResponseData" }, - "4221": { + "4228": { "sourceFileName": "../../../packages/medusa/src/utils/clean-response-data.ts", "qualifiedName": "T" }, - "4222": { + "4229": { "sourceFileName": "../../../packages/medusa/src/utils/clean-response-data.ts", "qualifiedName": "data" }, - "4223": { + "4230": { "sourceFileName": "../../../packages/medusa/src/utils/clean-response-data.ts", "qualifiedName": "fields" }, - "4224": { - "sourceFileName": "../../../packages/medusa/src/utils/csv-cell-content-formatter.ts", - "qualifiedName": "csvCellContentFormatter" - }, - "4225": { - "sourceFileName": "../../../packages/medusa/src/utils/csv-cell-content-formatter.ts", - "qualifiedName": "csvCellContentFormatter" - }, - "4226": { - "sourceFileName": "../../../packages/medusa/src/utils/csv-cell-content-formatter.ts", - "qualifiedName": "str" - }, - "4227": { - "sourceFileName": "../../../packages/medusa/src/utils/csv-cell-content-formatter.ts", - "qualifiedName": "csvRevertCellContentFormatter" - }, - "4228": { - "sourceFileName": "../../../packages/medusa/src/utils/csv-cell-content-formatter.ts", - "qualifiedName": "csvRevertCellContentFormatter" - }, - "4229": { - "sourceFileName": "../../../packages/medusa/src/utils/csv-cell-content-formatter.ts", - "qualifiedName": "str" - }, - "4230": { - "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", - "qualifiedName": "resolveDbType" - }, "4231": { - "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", - "qualifiedName": "resolveDbType" + "sourceFileName": "../../../packages/medusa/src/utils/csv-cell-content-formatter.ts", + "qualifiedName": "csvCellContentFormatter" }, "4232": { - "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", - "qualifiedName": "pgSqlType" + "sourceFileName": "../../../packages/medusa/src/utils/csv-cell-content-formatter.ts", + "qualifiedName": "csvCellContentFormatter" }, "4233": { - "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", - "qualifiedName": "resolveDbGenerationStrategy" + "sourceFileName": "../../../packages/medusa/src/utils/csv-cell-content-formatter.ts", + "qualifiedName": "str" }, "4234": { - "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", - "qualifiedName": "resolveDbGenerationStrategy" + "sourceFileName": "../../../packages/medusa/src/utils/csv-cell-content-formatter.ts", + "qualifiedName": "csvRevertCellContentFormatter" }, "4235": { - "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", - "qualifiedName": "pgSqlType" + "sourceFileName": "../../../packages/medusa/src/utils/csv-cell-content-formatter.ts", + "qualifiedName": "csvRevertCellContentFormatter" }, "4236": { - "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", - "qualifiedName": "DbAwareColumn" + "sourceFileName": "../../../packages/medusa/src/utils/csv-cell-content-formatter.ts", + "qualifiedName": "str" }, "4237": { "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", - "qualifiedName": "DbAwareColumn" + "qualifiedName": "resolveDbType" }, "4238": { "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", - "qualifiedName": "columnOptions" + "qualifiedName": "resolveDbType" }, "4239": { - "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", - "qualifiedName": "PostgresError" + "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", + "qualifiedName": "pgSqlType" }, "4240": { - "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", - "qualifiedName": "PostgresError.DUPLICATE_ERROR" + "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", + "qualifiedName": "resolveDbGenerationStrategy" }, "4241": { - "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", - "qualifiedName": "PostgresError.FOREIGN_KEY_ERROR" + "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", + "qualifiedName": "resolveDbGenerationStrategy" }, "4242": { - "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", - "qualifiedName": "PostgresError.SERIALIZATION_FAILURE" + "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", + "qualifiedName": "pgSqlType" }, "4243": { - "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", - "qualifiedName": "PostgresError.NULL_VIOLATION" + "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", + "qualifiedName": "DbAwareColumn" }, "4244": { - "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", - "qualifiedName": "formatException" + "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", + "qualifiedName": "DbAwareColumn" }, "4245": { - "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", - "qualifiedName": "formatException" + "sourceFileName": "../../../packages/medusa/src/utils/db-aware-column.ts", + "qualifiedName": "columnOptions" }, "4246": { "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", - "qualifiedName": "err" + "qualifiedName": "PostgresError" }, "4247": { - "sourceFileName": "../../../packages/medusa/src/utils/generate-entity-id.ts", - "qualifiedName": "generateEntityId" + "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", + "qualifiedName": "PostgresError.DUPLICATE_ERROR" }, "4248": { + "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", + "qualifiedName": "PostgresError.FOREIGN_KEY_ERROR" + }, + "4249": { + "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", + "qualifiedName": "PostgresError.SERIALIZATION_FAILURE" + }, + "4250": { + "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", + "qualifiedName": "PostgresError.NULL_VIOLATION" + }, + "4251": { + "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", + "qualifiedName": "formatException" + }, + "4252": { + "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", + "qualifiedName": "formatException" + }, + "4253": { + "sourceFileName": "../../../packages/medusa/src/utils/exception-formatter.ts", + "qualifiedName": "err" + }, + "4254": { "sourceFileName": "../../../packages/medusa/src/utils/generate-entity-id.ts", "qualifiedName": "generateEntityId" }, - "4249": { + "4255": { + "sourceFileName": "../../../packages/medusa/src/utils/generate-entity-id.ts", + "qualifiedName": "generateEntityId" + }, + "4256": { "sourceFileName": "../../../packages/medusa/src/utils/generate-entity-id.ts", "qualifiedName": "idProperty" }, - "4250": { + "4257": { "sourceFileName": "../../../packages/medusa/src/utils/generate-entity-id.ts", "qualifiedName": "prefix" }, - "4251": { + "4258": { "sourceFileName": "../../../packages/medusa/src/utils/has-changes.ts", "qualifiedName": "hasChanges" }, - "4252": { + "4259": { "sourceFileName": "../../../packages/medusa/src/utils/has-changes.ts", "qualifiedName": "hasChanges" }, - "4253": { + "4260": { "sourceFileName": "../../../packages/medusa/src/utils/has-changes.ts", "qualifiedName": "T1" }, - "4254": { + "4261": { "sourceFileName": "../../../packages/medusa/src/utils/has-changes.ts", "qualifiedName": "T2" }, - "4255": { + "4262": { "sourceFileName": "../../../packages/medusa/src/utils/has-changes.ts", "qualifiedName": "obj1" }, - "4256": { + "4263": { "sourceFileName": "../../../packages/medusa/src/utils/has-changes.ts", "qualifiedName": "obj2" }, - "4257": { + "4264": { "sourceFileName": "../../../packages/medusa/src/utils/is-date.ts", "qualifiedName": "isDate" }, - "4258": { + "4265": { "sourceFileName": "../../../packages/medusa/src/utils/is-date.ts", "qualifiedName": "isDate" }, - "4259": { + "4266": { "sourceFileName": "../../../packages/medusa/src/utils/is-date.ts", "qualifiedName": "value" }, - "4260": { + "4267": { "sourceFileName": "../../../packages/medusa/src/utils/is-object.ts", "qualifiedName": "isObject" }, - "4261": { + "4268": { "sourceFileName": "../../../packages/medusa/src/utils/is-object.ts", "qualifiedName": "isObject" }, - "4262": { + "4269": { "sourceFileName": "../../../packages/medusa/src/utils/is-object.ts", "qualifiedName": "obj" }, - "4263": { + "4270": { "sourceFileName": "../../../packages/medusa/src/utils/is-string.ts", "qualifiedName": "isString" }, - "4264": { + "4271": { "sourceFileName": "../../../packages/medusa/src/utils/is-string.ts", "qualifiedName": "isString" }, - "4265": { + "4272": { "sourceFileName": "../../../packages/medusa/src/utils/is-string.ts", "qualifiedName": "val" }, - "4266": { + "4273": { "sourceFileName": "../../../packages/medusa/src/utils/omit-deep.ts", "qualifiedName": "omitDeep" }, - "4267": { + "4274": { "sourceFileName": "../../../packages/medusa/src/utils/omit-deep.ts", "qualifiedName": "omitDeep" }, - "4268": { + "4275": { "sourceFileName": "../../../packages/medusa/src/utils/omit-deep.ts", "qualifiedName": "T" }, - "4269": { + "4276": { "sourceFileName": "../../../packages/medusa/src/utils/omit-deep.ts", "qualifiedName": "input" }, - "4270": { + "4277": { "sourceFileName": "../../../packages/medusa/src/utils/omit-deep.ts", "qualifiedName": "excludes" }, - "4271": { + "4278": { "sourceFileName": "../../../packages/medusa/src/utils/product-category/index.ts", "qualifiedName": "categoryMatchesScope" }, - "4272": { + "4279": { "sourceFileName": "../../../packages/medusa/src/utils/product-category/index.ts", "qualifiedName": "categoryMatchesScope" }, - "4273": { + "4280": { "sourceFileName": "../../../packages/medusa/src/utils/product-category/index.ts", "qualifiedName": "category" }, - "4274": { + "4281": { "sourceFileName": "../../../packages/medusa/src/utils/product-category/index.ts", "qualifiedName": "query" }, - "4275": { + "4282": { "sourceFileName": "../../../packages/medusa/src/utils/product-category/index.ts", "qualifiedName": "fetchCategoryDescendantsIds" }, - "4276": { + "4283": { "sourceFileName": "../../../packages/medusa/src/utils/product-category/index.ts", "qualifiedName": "fetchCategoryDescendantsIds" }, - "4277": { + "4284": { "sourceFileName": "../../../packages/medusa/src/utils/product-category/index.ts", "qualifiedName": "productCategory" }, - "4278": { + "4285": { "sourceFileName": "../../../packages/medusa/src/utils/product-category/index.ts", "qualifiedName": "query" }, - "4279": { + "4286": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/get-variants-from-price-list.ts", "qualifiedName": "getVariantsFromPriceList" }, - "4280": { + "4287": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/get-variants-from-price-list.ts", "qualifiedName": "getVariantsFromPriceList" }, - "4281": { + "4288": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/get-variants-from-price-list.ts", "qualifiedName": "container" }, - "4282": { + "4289": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/get-variants-from-price-list.ts", "qualifiedName": "priceListId" }, - "4283": { + "4290": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/list-products.ts", "qualifiedName": "listProducts" }, - "4284": { + "4291": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/list-products.ts", "qualifiedName": "listProducts" }, - "4285": { + "4292": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/list-products.ts", "qualifiedName": "container" }, - "4286": { + "4293": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/list-products.ts", "qualifiedName": "filterableFields" }, - "4287": { + "4294": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/list-products.ts", "qualifiedName": "listConfig" }, - "4288": { + "4295": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/retrieve-product.ts", "qualifiedName": "retrieveProduct" }, - "4289": { + "4296": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/retrieve-product.ts", "qualifiedName": "retrieveProduct" }, - "4290": { + "4297": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/retrieve-product.ts", "qualifiedName": "container" }, - "4291": { + "4298": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/retrieve-product.ts", "qualifiedName": "id" }, - "4292": { + "4299": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/retrieve-product.ts", "qualifiedName": "remoteQueryObject" }, - "4293": { + "4300": { "sourceFileName": "../../../packages/medusa/src/utils/queries/products/retrieve-product.ts", "qualifiedName": "__object" }, - "4294": { - "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", - "qualifiedName": "remoteQueryFetchData" - }, - "4295": { - "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", - "qualifiedName": "remoteQueryFetchData" - }, - "4296": { - "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", - "qualifiedName": "container" - }, - "4297": { - "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", - "qualifiedName": "__function" - }, - "4298": { - "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", - "qualifiedName": "__function" - }, - "4299": { - "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", - "qualifiedName": "expand" - }, - "4300": { - "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", - "qualifiedName": "keyField" - }, "4301": { "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", - "qualifiedName": "ids" + "qualifiedName": "remoteQueryFetchData" }, "4302": { "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", - "qualifiedName": "relationship" + "qualifiedName": "remoteQueryFetchData" }, "4303": { - "sourceFileName": "../../../packages/medusa/src/utils/remove-undefined-properties.ts", - "qualifiedName": "removeUndefinedProperties" + "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", + "qualifiedName": "container" }, "4304": { + "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", + "qualifiedName": "__function" + }, + "4305": { + "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", + "qualifiedName": "__function" + }, + "4306": { + "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", + "qualifiedName": "expand" + }, + "4307": { + "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", + "qualifiedName": "keyField" + }, + "4308": { + "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", + "qualifiedName": "ids" + }, + "4309": { + "sourceFileName": "../../../packages/medusa/src/utils/remote-query-fetch-data.ts", + "qualifiedName": "relationship" + }, + "4310": { "sourceFileName": "../../../packages/medusa/src/utils/remove-undefined-properties.ts", "qualifiedName": "removeUndefinedProperties" }, - "4305": { + "4311": { + "sourceFileName": "../../../packages/medusa/src/utils/remove-undefined-properties.ts", + "qualifiedName": "removeUndefinedProperties" + }, + "4312": { "sourceFileName": "../../../packages/medusa/src/utils/remove-undefined-properties.ts", "qualifiedName": "T" }, - "4306": { + "4313": { "sourceFileName": "../../../packages/medusa/src/utils/remove-undefined-properties.ts", "qualifiedName": "inputObj" }, - "4307": { + "4314": { "sourceFileName": "../../../packages/medusa/src/utils/set-metadata.ts", "qualifiedName": "setMetadata" }, - "4308": { + "4315": { "sourceFileName": "../../../packages/medusa/src/utils/set-metadata.ts", "qualifiedName": "setMetadata" }, - "4309": { + "4316": { "sourceFileName": "../../../packages/medusa/src/utils/set-metadata.ts", "qualifiedName": "obj" }, - "4310": { - "sourceFileName": "../../../packages/medusa/src/utils/set-metadata.ts", - "qualifiedName": "__type" - }, - "4311": { - "sourceFileName": "../../../packages/medusa/src/utils/set-metadata.ts", - "qualifiedName": "__type.metadata" - }, - "4312": { - "sourceFileName": "../../../packages/medusa/src/utils/set-metadata.ts", - "qualifiedName": "metadata" - }, - "4313": { - "sourceFileName": "../../../packages/medusa/src/utils/validate-id.ts", - "qualifiedName": "validateId" - }, - "4314": { - "sourceFileName": "../../../packages/medusa/src/utils/validate-id.ts", - "qualifiedName": "validateId" - }, - "4315": { - "sourceFileName": "../../../packages/medusa/src/utils/validate-id.ts", - "qualifiedName": "rawId" - }, - "4316": { - "sourceFileName": "../../../packages/medusa/src/utils/validate-id.ts", - "qualifiedName": "config" - }, "4317": { - "sourceFileName": "../../../packages/medusa/src/utils/validate-id.ts", + "sourceFileName": "../../../packages/medusa/src/utils/set-metadata.ts", "qualifiedName": "__type" }, "4318": { + "sourceFileName": "../../../packages/medusa/src/utils/set-metadata.ts", + "qualifiedName": "__type.metadata" + }, + "4319": { + "sourceFileName": "../../../packages/medusa/src/utils/set-metadata.ts", + "qualifiedName": "metadata" + }, + "4320": { + "sourceFileName": "../../../packages/medusa/src/utils/validate-id.ts", + "qualifiedName": "validateId" + }, + "4321": { + "sourceFileName": "../../../packages/medusa/src/utils/validate-id.ts", + "qualifiedName": "validateId" + }, + "4322": { + "sourceFileName": "../../../packages/medusa/src/utils/validate-id.ts", + "qualifiedName": "rawId" + }, + "4323": { + "sourceFileName": "../../../packages/medusa/src/utils/validate-id.ts", + "qualifiedName": "config" + }, + "4324": { + "sourceFileName": "../../../packages/medusa/src/utils/validate-id.ts", + "qualifiedName": "__type" + }, + "4325": { "sourceFileName": "../../../packages/medusa/src/utils/validate-id.ts", "qualifiedName": "__type.prefix" }, - "4319": { + "4326": { "sourceFileName": "../../../packages/medusa/src/utils/validate-id.ts", "qualifiedName": "__type.length" }, - "4320": { + "4327": { "sourceFileName": "../../../packages/medusa/src/utils/validators/is-type.ts", "qualifiedName": "IsType" }, - "4321": { + "4328": { "sourceFileName": "../../../packages/medusa/src/utils/validators/is-type.ts", "qualifiedName": "IsType" }, - "4322": { + "4329": { "sourceFileName": "../../../packages/medusa/src/utils/validators/is-type.ts", "qualifiedName": "types" }, - "4323": { + "4330": { "sourceFileName": "../../../packages/medusa/src/utils/validators/is-type.ts", "qualifiedName": "validationOptions" }, - "4324": { + "4331": { "sourceFileName": "../../../packages/medusa/src/utils/validators/is-type.ts", "qualifiedName": "__function" }, - "4325": { + "4332": { "sourceFileName": "../../../packages/medusa/src/utils/validators/is-type.ts", "qualifiedName": "__function" }, - "4326": { + "4333": { "sourceFileName": "../../../packages/medusa/src/utils/validators/is-type.ts", "qualifiedName": "object" }, - "4327": { + "4334": { "sourceFileName": "../../../packages/medusa/src/utils/validators/is-type.ts", "qualifiedName": "propertyName" }, - "4328": { + "4335": { "sourceFileName": "../../../packages/medusa/src/types/customer-groups.ts", "qualifiedName": "CustomerGroupsBatchCustomer" }, - "4331": { + "4338": { "sourceFileName": "../../../packages/medusa/src/types/customer-groups.ts", "qualifiedName": "CustomerGroupsBatchCustomer.id" }, - "4332": { + "4339": { "sourceFileName": "../../../packages/medusa/src/types/customer-groups.ts", "qualifiedName": "FilterableCustomerGroupProps" }, - "4335": { + "4342": { "sourceFileName": "../../../packages/medusa/src/types/customer-groups.ts", "qualifiedName": "FilterableCustomerGroupProps.id" }, - "4336": { + "4343": { "sourceFileName": "../../../packages/medusa/src/types/customer-groups.ts", "qualifiedName": "FilterableCustomerGroupProps.q" }, - "4337": { + "4344": { "sourceFileName": "../../../packages/medusa/src/types/customer-groups.ts", "qualifiedName": "FilterableCustomerGroupProps.name" }, - "4338": { + "4345": { "sourceFileName": "../../../packages/medusa/src/types/customer-groups.ts", "qualifiedName": "FilterableCustomerGroupProps.updated_at" }, - "4339": { + "4346": { "sourceFileName": "../../../packages/medusa/src/types/customer-groups.ts", "qualifiedName": "FilterableCustomerGroupProps.created_at" }, - "4340": { + "4347": { "sourceFileName": "../../../packages/medusa/src/types/customer-groups.ts", "qualifiedName": "FilterableCustomerGroupProps.discount_condition_id" }, - "4341": { + "4348": { "sourceFileName": "../../../packages/medusa/src/types/customers.ts", "qualifiedName": "AdminListCustomerSelector" }, - "4344": { + "4351": { "sourceFileName": "../../../packages/medusa/src/types/customers.ts", "qualifiedName": "AdminListCustomerSelector.q" }, - "4345": { + "4352": { "sourceFileName": "../../../packages/medusa/src/types/customers.ts", "qualifiedName": "AdminListCustomerSelector.has_account" }, - "4346": { + "4353": { "sourceFileName": "../../../packages/medusa/src/types/customers.ts", "qualifiedName": "AdminListCustomerSelector.groups" }, - "4347": { + "4354": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/customers/update-customer.ts", "qualifiedName": "Group" }, - "4350": { + "4357": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/customers/update-customer.ts", "qualifiedName": "Group.id" }, - "4351": { + "4358": { "sourceFileName": "../../../packages/medusa/src/types/discount.ts", "qualifiedName": "AdminUpsertConditionsReq" }, - "4354": { + "4361": { "sourceFileName": "../../../packages/medusa/src/types/discount.ts", "qualifiedName": "AdminUpsertConditionsReq.products" }, - "4355": { + "4362": { "sourceFileName": "../../../packages/medusa/src/types/discount.ts", "qualifiedName": "AdminUpsertConditionsReq.product_collections" }, - "4356": { + "4363": { "sourceFileName": "../../../packages/medusa/src/types/discount.ts", "qualifiedName": "AdminUpsertConditionsReq.product_types" }, - "4357": { + "4364": { "sourceFileName": "../../../packages/medusa/src/types/discount.ts", "qualifiedName": "AdminUpsertConditionsReq.product_tags" }, - "4358": { + "4365": { "sourceFileName": "../../../packages/medusa/src/types/discount.ts", "qualifiedName": "AdminUpsertConditionsReq.customer_groups" }, - "4359": { + "4366": { "sourceFileName": "../../../packages/medusa/src/types/discount.ts", "qualifiedName": "AdminGetDiscountsDiscountRuleParams" }, - "4362": { + "4369": { "sourceFileName": "../../../packages/medusa/src/types/discount.ts", "qualifiedName": "AdminGetDiscountsDiscountRuleParams.type" }, - "4363": { + "4370": { "sourceFileName": "../../../packages/medusa/src/types/discount.ts", "qualifiedName": "AdminGetDiscountsDiscountRuleParams.allocation" }, - "4364": { + "4371": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", "qualifiedName": "Item" }, - "4367": { + "4374": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", "qualifiedName": "Item.title" }, - "4368": { + "4375": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", "qualifiedName": "Item.unit_price" }, - "4369": { + "4376": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", "qualifiedName": "Item.variant_id" }, - "4370": { + "4377": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", "qualifiedName": "Item.quantity" }, - "4371": { + "4378": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", "qualifiedName": "Item.metadata" }, - "4372": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", - "qualifiedName": "Discount" - }, - "4375": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", - "qualifiedName": "Discount.code" - }, - "4376": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", - "qualifiedName": "ShippingMethod" - }, "4379": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", + "qualifiedName": "Discount" + }, + "4382": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", + "qualifiedName": "Discount.code" + }, + "4383": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", + "qualifiedName": "ShippingMethod" + }, + "4386": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", "qualifiedName": "ShippingMethod.option_id" }, - "4380": { + "4387": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", "qualifiedName": "ShippingMethod.data" }, - "4381": { + "4388": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/create-draft-order.ts", "qualifiedName": "ShippingMethod.price" }, - "4382": { + "4389": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts", "qualifiedName": "Discount" }, - "4385": { + "4392": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/draft-orders/update-draft-order.ts", "qualifiedName": "Discount.code" }, - "4386": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "InventoryItemDTO" - }, - "4387": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type" - }, - "4388": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.id" - }, - "4389": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.sku" - }, - "4390": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.origin_country" - }, - "4391": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.hs_code" - }, - "4392": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.requires_shipping" - }, "4393": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.mid_code" + "qualifiedName": "InventoryItemDTO" }, "4394": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.material" + "qualifiedName": "__type" }, "4395": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.weight" + "qualifiedName": "__type.id" }, "4396": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.length" + "qualifiedName": "__type.sku" }, "4397": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.height" + "qualifiedName": "__type.origin_country" }, "4398": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.width" + "qualifiedName": "__type.hs_code" }, "4399": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.title" + "qualifiedName": "__type.requires_shipping" }, "4400": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.description" + "qualifiedName": "__type.mid_code" }, "4401": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.thumbnail" + "qualifiedName": "__type.material" }, "4402": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.metadata" + "qualifiedName": "__type.weight" }, "4403": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.created_at" + "qualifiedName": "__type.length" }, "4404": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.updated_at" + "qualifiedName": "__type.height" }, "4405": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.deleted_at" + "qualifiedName": "__type.width" }, "4406": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "InventoryLevelDTO" + "qualifiedName": "__type.title" }, "4407": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.description" }, "4408": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.id" + "qualifiedName": "__type.thumbnail" }, "4409": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.inventory_item_id" + "qualifiedName": "__type.metadata" }, "4410": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.location_id" + "qualifiedName": "__type.created_at" }, "4411": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.stocked_quantity" + "qualifiedName": "__type.updated_at" }, "4412": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.reserved_quantity" + "qualifiedName": "__type.deleted_at" }, "4413": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.incoming_quantity" + "qualifiedName": "InventoryLevelDTO" }, "4414": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.metadata" + "qualifiedName": "__type" }, "4415": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.created_at" + "qualifiedName": "__type.id" }, "4416": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.updated_at" + "qualifiedName": "__type.inventory_item_id" }, "4417": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.deleted_at" + "qualifiedName": "__type.location_id" }, "4418": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.stocked_quantity" + }, + "4419": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.reserved_quantity" + }, + "4420": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.incoming_quantity" + }, + "4421": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.metadata" + }, + "4422": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.created_at" + }, + "4423": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.updated_at" + }, + "4424": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.deleted_at" + }, + "4425": { "sourceFileName": "../../../packages/types/src/common/common.ts", "qualifiedName": "PaginatedResponse" }, - "4419": { + "4426": { "sourceFileName": "../../../packages/types/src/common/common.ts", "qualifiedName": "__type" }, - "4420": { + "4427": { "sourceFileName": "../../../packages/types/src/common/common.ts", "qualifiedName": "__type.limit" }, - "4421": { + "4428": { "sourceFileName": "../../../packages/types/src/common/common.ts", "qualifiedName": "__type.offset" }, - "4422": { + "4429": { "sourceFileName": "../../../packages/types/src/common/common.ts", "qualifiedName": "__type.count" }, - "4423": { + "4430": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", "qualifiedName": "Item" }, - "4426": { + "4433": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", "qualifiedName": "Item.item_id" }, - "4427": { + "4434": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", "qualifiedName": "Item.quantity" }, - "4428": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "Item.note" - }, - "4429": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "Item.reason" - }, - "4430": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "Item.tags" - }, - "4431": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "Item.images" - }, - "4432": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "ReturnShipping" - }, "4435": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "ReturnShipping.option_id" + "qualifiedName": "Item.note" }, "4436": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "ReturnShipping.price" + "qualifiedName": "Item.reason" }, "4437": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "AdditionalItem" + "qualifiedName": "Item.tags" }, - "4440": { + "4438": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "AdditionalItem.variant_id" + "qualifiedName": "Item.images" }, - "4441": { + "4439": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "AdditionalItem.quantity" + "qualifiedName": "ReturnShipping" }, "4442": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "ShippingMethod" + "qualifiedName": "ReturnShipping.option_id" }, - "4445": { + "4443": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "ShippingMethod.id" + "qualifiedName": "ReturnShipping.price" }, - "4446": { + "4444": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "ShippingMethod.option_id" + "qualifiedName": "AdditionalItem" }, "4447": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "ShippingMethod.price" + "qualifiedName": "AdditionalItem.variant_id" }, "4448": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", - "qualifiedName": "ShippingMethod.data" + "qualifiedName": "AdditionalItem.quantity" }, "4449": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", + "qualifiedName": "ShippingMethod" + }, + "4452": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", + "qualifiedName": "ShippingMethod.id" + }, + "4453": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", + "qualifiedName": "ShippingMethod.option_id" + }, + "4454": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", + "qualifiedName": "ShippingMethod.price" + }, + "4455": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-claim.ts", + "qualifiedName": "ShippingMethod.data" + }, + "4456": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts", "qualifiedName": "Item" }, - "4452": { + "4459": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts", "qualifiedName": "Item.item_id" }, - "4453": { + "4460": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-fulfillment.ts", "qualifiedName": "Item.quantity" }, - "4454": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", - "qualifiedName": "ReturnItem" - }, - "4457": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", - "qualifiedName": "ReturnItem.item_id" - }, - "4458": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", - "qualifiedName": "ReturnItem.quantity" - }, - "4459": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", - "qualifiedName": "ReturnItem.reason_id" - }, - "4460": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", - "qualifiedName": "ReturnItem.note" - }, "4461": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", - "qualifiedName": "ReturnShipping" + "qualifiedName": "ReturnItem" }, "4464": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", - "qualifiedName": "ReturnShipping.option_id" + "qualifiedName": "ReturnItem.item_id" }, "4465": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", - "qualifiedName": "ReturnShipping.price" + "qualifiedName": "ReturnItem.quantity" }, "4466": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", - "qualifiedName": "AdditionalItem" + "qualifiedName": "ReturnItem.reason_id" }, - "4469": { + "4467": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", - "qualifiedName": "AdditionalItem.variant_id" + "qualifiedName": "ReturnItem.note" }, - "4470": { + "4468": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", - "qualifiedName": "AdditionalItem.quantity" + "qualifiedName": "ReturnShipping" }, "4471": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", + "qualifiedName": "ReturnShipping.option_id" + }, + "4472": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", + "qualifiedName": "ReturnShipping.price" + }, + "4473": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", + "qualifiedName": "AdditionalItem" + }, + "4476": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", + "qualifiedName": "AdditionalItem.variant_id" + }, + "4477": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", + "qualifiedName": "AdditionalItem.quantity" + }, + "4478": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", "qualifiedName": "CustomShippingOption" }, - "4474": { + "4481": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", "qualifiedName": "CustomShippingOption.option_id" }, - "4475": { + "4482": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/create-swap.ts", "qualifiedName": "CustomShippingOption.price" }, - "4476": { + "4483": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector" }, - "4479": { + "4486": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.q" }, - "4480": { + "4487": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.id" }, - "4481": { + "4488": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.status" }, - "4482": { + "4489": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.fulfillment_status" }, - "4483": { + "4490": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.payment_status" }, - "4484": { + "4491": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.display_id" }, - "4485": { + "4492": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.cart_id" }, - "4486": { + "4493": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.customer_id" }, - "4487": { + "4494": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.email" }, - "4488": { + "4495": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.region_id" }, - "4489": { + "4496": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.currency_code" }, - "4490": { + "4497": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.tax_rate" }, - "4491": { + "4498": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.sales_channel_id" }, - "4492": { + "4499": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.canceled_at" }, - "4493": { + "4500": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.created_at" }, - "4494": { + "4501": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "AdminListOrdersSelector.updated_at" }, - "4495": { + "4502": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "OrdersReturnItem" }, - "4498": { + "4505": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "OrdersReturnItem.item_id" }, - "4499": { + "4506": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "OrdersReturnItem.quantity" }, - "4500": { + "4507": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "OrdersReturnItem.reason_id" }, - "4501": { + "4508": { "sourceFileName": "../../../packages/medusa/src/types/orders.ts", "qualifiedName": "OrdersReturnItem.note" }, - "4502": { + "4509": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/request-return.ts", "qualifiedName": "ReturnShipping" }, - "4505": { + "4512": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/request-return.ts", "qualifiedName": "ReturnShipping.option_id" }, - "4506": { + "4513": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/request-return.ts", "qualifiedName": "ReturnShipping.price" }, - "4507": { + "4514": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", "qualifiedName": "Item" }, - "4510": { + "4517": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", "qualifiedName": "Item.id" }, - "4511": { + "4518": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", "qualifiedName": "Item.note" }, - "4512": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", - "qualifiedName": "Item.reason" - }, - "4513": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", - "qualifiedName": "Item.images" - }, - "4514": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", - "qualifiedName": "Item.tags" - }, - "4515": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", - "qualifiedName": "Item.metadata" - }, - "4516": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", - "qualifiedName": "ShippingMethod" - }, "4519": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", - "qualifiedName": "ShippingMethod.id" + "qualifiedName": "Item.reason" }, "4520": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", - "qualifiedName": "ShippingMethod.option_id" + "qualifiedName": "Item.images" }, "4521": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", - "qualifiedName": "ShippingMethod.price" + "qualifiedName": "Item.tags" }, "4522": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", - "qualifiedName": "ShippingMethod.data" + "qualifiedName": "Item.metadata" }, "4523": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", + "qualifiedName": "ShippingMethod" + }, + "4526": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", + "qualifiedName": "ShippingMethod.id" + }, + "4527": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", + "qualifiedName": "ShippingMethod.option_id" + }, + "4528": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", + "qualifiedName": "ShippingMethod.price" + }, + "4529": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", + "qualifiedName": "ShippingMethod.data" + }, + "4530": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-order.ts", "qualifiedName": "PaymentMethod" }, - "4526": { + "4533": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-order.ts", "qualifiedName": "PaymentMethod.provider_id" }, - "4527": { + "4534": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-order.ts", "qualifiedName": "PaymentMethod.data" }, - "4528": { + "4535": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-order.ts", "qualifiedName": "ShippingMethod" }, - "4531": { + "4538": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-order.ts", "qualifiedName": "ShippingMethod.provider_id" }, - "4532": { + "4539": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-order.ts", "qualifiedName": "ShippingMethod.profile_id" }, - "4533": { + "4540": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-order.ts", "qualifiedName": "ShippingMethod.price" }, - "4534": { + "4541": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-order.ts", "qualifiedName": "ShippingMethod.data" }, - "4535": { + "4542": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-order.ts", "qualifiedName": "ShippingMethod.items" }, - "4536": { + "4543": { "sourceFileName": "../../../packages/utils/dist/pricing/price-list.d.ts", "qualifiedName": "PriceListStatus" }, - "4537": { + "4544": { "sourceFileName": "../../../packages/utils/dist/pricing/price-list.d.ts", "qualifiedName": "PriceListStatus.ACTIVE" }, - "4538": { + "4545": { "sourceFileName": "../../../packages/utils/dist/pricing/price-list.d.ts", "qualifiedName": "PriceListStatus.DRAFT" }, - "4539": { + "4546": { "sourceFileName": "../../../packages/utils/dist/pricing/price-list.d.ts", "qualifiedName": "PriceListType" }, - "4540": { + "4547": { "sourceFileName": "../../../packages/utils/dist/pricing/price-list.d.ts", "qualifiedName": "PriceListType.SALE" }, - "4541": { + "4548": { "sourceFileName": "../../../packages/utils/dist/pricing/price-list.d.ts", "qualifiedName": "PriceListType.OVERRIDE" }, - "4542": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts", - "qualifiedName": "CustomerGroup" - }, - "4545": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts", - "qualifiedName": "CustomerGroup.id" - }, - "4546": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts", - "qualifiedName": "CustomerGroup" - }, "4549": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts", - "qualifiedName": "CustomerGroup.id" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts", + "qualifiedName": "CustomerGroup" }, - "4550": { - "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", - "qualifiedName": "AdminProductCategoriesReqBase" + "4552": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/price-lists/create-price-list.ts", + "qualifiedName": "CustomerGroup.id" }, "4553": { - "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", - "qualifiedName": "AdminProductCategoriesReqBase.description" - }, - "4554": { - "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", - "qualifiedName": "AdminProductCategoriesReqBase.handle" - }, - "4555": { - "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", - "qualifiedName": "AdminProductCategoriesReqBase.is_internal" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts", + "qualifiedName": "CustomerGroup" }, "4556": { - "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", - "qualifiedName": "AdminProductCategoriesReqBase.is_active" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/price-lists/update-price-list.ts", + "qualifiedName": "CustomerGroup.id" }, "4557": { "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", - "qualifiedName": "AdminProductCategoriesReqBase.parent_category_id" + "qualifiedName": "AdminProductCategoriesReqBase" }, - "4558": { + "4560": { "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", - "qualifiedName": "ProductBatchProductCategory" + "qualifiedName": "AdminProductCategoriesReqBase.description" }, "4561": { "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", - "qualifiedName": "ProductBatchProductCategory.id" + "qualifiedName": "AdminProductCategoriesReqBase.handle" }, "4562": { + "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", + "qualifiedName": "AdminProductCategoriesReqBase.is_internal" + }, + "4563": { + "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", + "qualifiedName": "AdminProductCategoriesReqBase.is_active" + }, + "4564": { + "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", + "qualifiedName": "AdminProductCategoriesReqBase.parent_category_id" + }, + "4565": { + "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", + "qualifiedName": "ProductBatchProductCategory" + }, + "4568": { + "sourceFileName": "../../../packages/medusa/src/types/product-category.ts", + "qualifiedName": "ProductBatchProductCategory.id" + }, + "4569": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "PricedProduct" }, - "4563": { + "4570": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type" }, - "4564": { + "4571": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.variants" }, - "4565": { + "4572": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", "qualifiedName": "ProductTypeReq" }, - "4568": { + "4575": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", "qualifiedName": "ProductTypeReq.id" }, - "4569": { + "4576": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", "qualifiedName": "ProductTypeReq.value" }, - "4570": { + "4577": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", "qualifiedName": "ProductTagReq" }, - "4573": { + "4580": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", "qualifiedName": "ProductTagReq.id" }, - "4574": { + "4581": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", "qualifiedName": "ProductTagReq.value" }, - "4575": { + "4582": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", "qualifiedName": "ProductSalesChannelReq" }, - "4578": { + "4585": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", "qualifiedName": "ProductSalesChannelReq.id" }, - "4579": { + "4586": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", "qualifiedName": "ProductProductCategoryReq" }, - "4582": { + "4589": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", "qualifiedName": "ProductProductCategoryReq.id" }, - "4583": { + "4590": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", "qualifiedName": "ProductOptionReq" }, - "4586": { + "4593": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", "qualifiedName": "ProductOptionReq.title" }, - "4587": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq" - }, - "4590": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.title" - }, - "4591": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.sku" - }, - "4592": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.ean" - }, - "4593": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.upc" - }, "4594": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.barcode" - }, - "4595": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.hs_code" - }, - "4596": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.inventory_quantity" + "qualifiedName": "ProductVariantReq" }, "4597": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.allow_backorder" + "qualifiedName": "ProductVariantReq.title" }, "4598": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.manage_inventory" + "qualifiedName": "ProductVariantReq.sku" }, "4599": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.weight" + "qualifiedName": "ProductVariantReq.ean" }, "4600": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.length" + "qualifiedName": "ProductVariantReq.upc" }, "4601": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.height" + "qualifiedName": "ProductVariantReq.barcode" }, "4602": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.width" + "qualifiedName": "ProductVariantReq.hs_code" }, "4603": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.origin_country" + "qualifiedName": "ProductVariantReq.inventory_quantity" }, "4604": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.mid_code" + "qualifiedName": "ProductVariantReq.allow_backorder" }, "4605": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.material" + "qualifiedName": "ProductVariantReq.manage_inventory" }, "4606": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.metadata" + "qualifiedName": "ProductVariantReq.weight" }, "4607": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.prices" + "qualifiedName": "ProductVariantReq.length" }, "4608": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", - "qualifiedName": "ProductVariantReq.options" + "qualifiedName": "ProductVariantReq.height" }, "4609": { - "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", - "qualifiedName": "ProductVariantPricesCreateReq" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", + "qualifiedName": "ProductVariantReq.width" + }, + "4610": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", + "qualifiedName": "ProductVariantReq.origin_country" + }, + "4611": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", + "qualifiedName": "ProductVariantReq.mid_code" }, "4612": { - "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", - "qualifiedName": "ProductVariantPricesCreateReq.region_id" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", + "qualifiedName": "ProductVariantReq.material" }, "4613": { - "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", - "qualifiedName": "ProductVariantPricesCreateReq.currency_code" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", + "qualifiedName": "ProductVariantReq.metadata" }, "4614": { - "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", - "qualifiedName": "ProductVariantPricesCreateReq.amount" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", + "qualifiedName": "ProductVariantReq.prices" }, "4615": { - "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", - "qualifiedName": "ProductVariantPricesCreateReq.min_quantity" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", + "qualifiedName": "ProductVariantReq.options" }, "4616": { + "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", + "qualifiedName": "ProductVariantPricesCreateReq" + }, + "4619": { + "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", + "qualifiedName": "ProductVariantPricesCreateReq.region_id" + }, + "4620": { + "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", + "qualifiedName": "ProductVariantPricesCreateReq.currency_code" + }, + "4621": { + "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", + "qualifiedName": "ProductVariantPricesCreateReq.amount" + }, + "4622": { + "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", + "qualifiedName": "ProductVariantPricesCreateReq.min_quantity" + }, + "4623": { "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", "qualifiedName": "ProductVariantPricesCreateReq.max_quantity" }, - "4617": { + "4624": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-variant.ts", "qualifiedName": "ProductVariantOptionReq" }, - "4620": { + "4627": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-variant.ts", "qualifiedName": "ProductVariantOptionReq.value" }, - "4621": { + "4628": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-variant.ts", "qualifiedName": "ProductVariantOptionReq.option_id" }, - "4622": { - "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps" - }, - "4625": { - "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.id" - }, - "4626": { - "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.q" - }, - "4627": { - "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.status" - }, - "4628": { - "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.price_list_id" - }, "4629": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.collection_id" - }, - "4630": { - "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.tags" - }, - "4631": { - "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.title" + "qualifiedName": "FilterableProductProps" }, "4632": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.description" + "qualifiedName": "FilterableProductProps.id" }, "4633": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.handle" + "qualifiedName": "FilterableProductProps.q" }, "4634": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.is_giftcard" + "qualifiedName": "FilterableProductProps.status" }, "4635": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.type_id" + "qualifiedName": "FilterableProductProps.price_list_id" }, "4636": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.sales_channel_id" + "qualifiedName": "FilterableProductProps.collection_id" }, "4637": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.discount_condition_id" + "qualifiedName": "FilterableProductProps.tags" }, "4638": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.category_id" + "qualifiedName": "FilterableProductProps.title" }, "4639": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.include_category_children" + "qualifiedName": "FilterableProductProps.description" }, "4640": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.created_at" + "qualifiedName": "FilterableProductProps.handle" }, "4641": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.updated_at" + "qualifiedName": "FilterableProductProps.is_giftcard" }, "4642": { "sourceFileName": "../../../packages/medusa/src/types/product.ts", - "qualifiedName": "FilterableProductProps.deleted_at" + "qualifiedName": "FilterableProductProps.type_id" }, "4643": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq" + "sourceFileName": "../../../packages/medusa/src/types/product.ts", + "qualifiedName": "FilterableProductProps.sales_channel_id" + }, + "4644": { + "sourceFileName": "../../../packages/medusa/src/types/product.ts", + "qualifiedName": "FilterableProductProps.discount_condition_id" + }, + "4645": { + "sourceFileName": "../../../packages/medusa/src/types/product.ts", + "qualifiedName": "FilterableProductProps.category_id" }, "4646": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.id" + "sourceFileName": "../../../packages/medusa/src/types/product.ts", + "qualifiedName": "FilterableProductProps.include_category_children" }, "4647": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.title" + "sourceFileName": "../../../packages/medusa/src/types/product.ts", + "qualifiedName": "FilterableProductProps.created_at" }, "4648": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.sku" + "sourceFileName": "../../../packages/medusa/src/types/product.ts", + "qualifiedName": "FilterableProductProps.updated_at" }, "4649": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.ean" + "sourceFileName": "../../../packages/medusa/src/types/product.ts", + "qualifiedName": "FilterableProductProps.deleted_at" }, "4650": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.upc" - }, - "4651": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.barcode" - }, - "4652": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.hs_code" + "qualifiedName": "ProductVariantReq" }, "4653": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.inventory_quantity" + "qualifiedName": "ProductVariantReq.id" }, "4654": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.allow_backorder" + "qualifiedName": "ProductVariantReq.title" }, "4655": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.manage_inventory" + "qualifiedName": "ProductVariantReq.sku" }, "4656": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.weight" + "qualifiedName": "ProductVariantReq.ean" }, "4657": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.length" + "qualifiedName": "ProductVariantReq.upc" }, "4658": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.height" + "qualifiedName": "ProductVariantReq.barcode" }, "4659": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.width" + "qualifiedName": "ProductVariantReq.hs_code" }, "4660": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.origin_country" + "qualifiedName": "ProductVariantReq.inventory_quantity" }, "4661": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.mid_code" + "qualifiedName": "ProductVariantReq.allow_backorder" }, "4662": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.material" + "qualifiedName": "ProductVariantReq.manage_inventory" }, "4663": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.metadata" + "qualifiedName": "ProductVariantReq.weight" }, "4664": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.prices" + "qualifiedName": "ProductVariantReq.length" }, "4665": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", - "qualifiedName": "ProductVariantReq.options" + "qualifiedName": "ProductVariantReq.height" }, "4666": { - "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", - "qualifiedName": "ProductVariantPricesUpdateReq" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", + "qualifiedName": "ProductVariantReq.width" + }, + "4667": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", + "qualifiedName": "ProductVariantReq.origin_country" + }, + "4668": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", + "qualifiedName": "ProductVariantReq.mid_code" }, "4669": { - "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", - "qualifiedName": "ProductVariantPricesUpdateReq.id" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", + "qualifiedName": "ProductVariantReq.material" }, "4670": { - "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", - "qualifiedName": "ProductVariantPricesUpdateReq.region_id" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", + "qualifiedName": "ProductVariantReq.metadata" }, "4671": { - "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", - "qualifiedName": "ProductVariantPricesUpdateReq.currency_code" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", + "qualifiedName": "ProductVariantReq.prices" }, "4672": { - "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", - "qualifiedName": "ProductVariantPricesUpdateReq.amount" + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", + "qualifiedName": "ProductVariantReq.options" }, "4673": { + "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", + "qualifiedName": "ProductVariantPricesUpdateReq" + }, + "4676": { + "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", + "qualifiedName": "ProductVariantPricesUpdateReq.id" + }, + "4677": { + "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", + "qualifiedName": "ProductVariantPricesUpdateReq.region_id" + }, + "4678": { + "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", + "qualifiedName": "ProductVariantPricesUpdateReq.currency_code" + }, + "4679": { + "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", + "qualifiedName": "ProductVariantPricesUpdateReq.amount" + }, + "4680": { "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", "qualifiedName": "ProductVariantPricesUpdateReq.min_quantity" }, - "4674": { + "4681": { "sourceFileName": "../../../packages/medusa/src/types/product-variant.ts", "qualifiedName": "ProductVariantPricesUpdateReq.max_quantity" }, - "4675": { + "4682": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-variant.ts", "qualifiedName": "ProductVariantOptionReq" }, - "4678": { + "4685": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-variant.ts", "qualifiedName": "ProductVariantOptionReq.value" }, - "4679": { + "4686": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-variant.ts", "qualifiedName": "ProductVariantOptionReq.option_id" }, - "4680": { + "4687": { "sourceFileName": "../../../packages/medusa/src/types/sales-channels.ts", "qualifiedName": "ProductBatchSalesChannel" }, - "4683": { + "4690": { "sourceFileName": "../../../packages/medusa/src/types/sales-channels.ts", "qualifiedName": "ProductBatchSalesChannel.id" }, - "4684": { + "4691": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/returns/receive-return.ts", "qualifiedName": "Item" }, - "4687": { + "4694": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/returns/receive-return.ts", "qualifiedName": "Item.item_id" }, - "4688": { + "4695": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/returns/receive-return.ts", "qualifiedName": "Item.quantity" }, - "4689": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "ReservationItemDTO" - }, - "4690": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type" - }, - "4691": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.id" - }, - "4692": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.location_id" - }, - "4693": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.inventory_item_id" - }, - "4694": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.quantity" - }, - "4695": { - "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.line_item_id" - }, "4696": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.description" + "qualifiedName": "ReservationItemDTO" }, "4697": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.created_by" + "qualifiedName": "__type" }, "4698": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.metadata" + "qualifiedName": "__type.id" }, "4699": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.created_at" + "qualifiedName": "__type.location_id" }, "4700": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.updated_at" + "qualifiedName": "__type.inventory_item_id" }, "4701": { "sourceFileName": "../../../packages/types/src/inventory/common.ts", - "qualifiedName": "__type.deleted_at" + "qualifiedName": "__type.quantity" }, "4702": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.line_item_id" + }, + "4703": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.description" + }, + "4704": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.created_by" + }, + "4705": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.metadata" + }, + "4706": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.created_at" + }, + "4707": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.updated_at" + }, + "4708": { + "sourceFileName": "../../../packages/types/src/inventory/common.ts", + "qualifiedName": "__type.deleted_at" + }, + "4709": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts", "qualifiedName": "OptionRequirement" }, - "4705": { + "4712": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts", "qualifiedName": "OptionRequirement.type" }, - "4706": { + "4713": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/shipping-options/create-shipping-option.ts", "qualifiedName": "OptionRequirement.amount" }, - "4707": { + "4714": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts", "qualifiedName": "OptionRequirement" }, - "4710": { + "4717": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts", "qualifiedName": "OptionRequirement.id" }, - "4711": { + "4718": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts", "qualifiedName": "OptionRequirement.type" }, - "4712": { + "4719": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/shipping-options/update-shipping-option.ts", "qualifiedName": "OptionRequirement.amount" }, - "4713": { + "4720": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "StockLocationDTO" }, - "4714": { - "sourceFileName": "../../../packages/types/src/stock-location/common.ts", - "qualifiedName": "__type" - }, - "4715": { - "sourceFileName": "../../../packages/types/src/stock-location/common.ts", - "qualifiedName": "__type.id" - }, - "4716": { - "sourceFileName": "../../../packages/types/src/stock-location/common.ts", - "qualifiedName": "__type.name" - }, - "4717": { - "sourceFileName": "../../../packages/types/src/stock-location/common.ts", - "qualifiedName": "__type.metadata" - }, - "4718": { - "sourceFileName": "../../../packages/types/src/stock-location/common.ts", - "qualifiedName": "__type.address_id" - }, - "4719": { - "sourceFileName": "../../../packages/types/src/stock-location/common.ts", - "qualifiedName": "__type.address" - }, - "4720": { - "sourceFileName": "../../../packages/types/src/stock-location/common.ts", - "qualifiedName": "__type.created_at" - }, "4721": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", - "qualifiedName": "__type.updated_at" + "qualifiedName": "__type" }, "4722": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", - "qualifiedName": "__type.deleted_at" - }, - "4723": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "DeleteResponse" - }, - "4724": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type" - }, - "4725": { - "sourceFileName": "../../../packages/types/src/common/common.ts", "qualifiedName": "__type.id" }, + "4723": { + "sourceFileName": "../../../packages/types/src/stock-location/common.ts", + "qualifiedName": "__type.name" + }, + "4724": { + "sourceFileName": "../../../packages/types/src/stock-location/common.ts", + "qualifiedName": "__type.metadata" + }, + "4725": { + "sourceFileName": "../../../packages/types/src/stock-location/common.ts", + "qualifiedName": "__type.address_id" + }, "4726": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.object" + "sourceFileName": "../../../packages/types/src/stock-location/common.ts", + "qualifiedName": "__type.address" }, "4727": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.deleted" + "sourceFileName": "../../../packages/types/src/stock-location/common.ts", + "qualifiedName": "__type.created_at" }, "4728": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", - "qualifiedName": "StockLocationExpandedDTO" + "qualifiedName": "__type.updated_at" }, "4729": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.deleted_at" }, "4730": { + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "DeleteResponse" + }, + "4731": { + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type" + }, + "4732": { + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.id" + }, + "4733": { + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.object" + }, + "4734": { + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.deleted" + }, + "4735": { + "sourceFileName": "../../../packages/types/src/stock-location/common.ts", + "qualifiedName": "StockLocationExpandedDTO" + }, + "4736": { + "sourceFileName": "../../../packages/types/src/stock-location/common.ts", + "qualifiedName": "__type" + }, + "4737": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.sales_channels" }, - "4731": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", - "qualifiedName": "StockLocationAddress" - }, - "4734": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", - "qualifiedName": "StockLocationAddress.address_1" - }, - "4735": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", - "qualifiedName": "StockLocationAddress.address_2" - }, - "4736": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", - "qualifiedName": "StockLocationAddress.company" - }, - "4737": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", - "qualifiedName": "StockLocationAddress.city" - }, "4738": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", - "qualifiedName": "StockLocationAddress.country_code" - }, - "4739": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", - "qualifiedName": "StockLocationAddress.phone" - }, - "4740": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", - "qualifiedName": "StockLocationAddress.postal_code" + "qualifiedName": "StockLocationAddress" }, "4741": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", - "qualifiedName": "StockLocationAddress.province" - }, - "4742": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", - "qualifiedName": "StockLocationAddress" - }, - "4745": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", "qualifiedName": "StockLocationAddress.address_1" }, - "4746": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", + "4742": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", "qualifiedName": "StockLocationAddress.address_2" }, - "4747": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", + "4743": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", "qualifiedName": "StockLocationAddress.company" }, - "4748": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", + "4744": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", "qualifiedName": "StockLocationAddress.city" }, + "4745": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", + "qualifiedName": "StockLocationAddress.country_code" + }, + "4746": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", + "qualifiedName": "StockLocationAddress.phone" + }, + "4747": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", + "qualifiedName": "StockLocationAddress.postal_code" + }, + "4748": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/create-stock-location.ts", + "qualifiedName": "StockLocationAddress.province" + }, "4749": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", - "qualifiedName": "StockLocationAddress.country_code" - }, - "4750": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", - "qualifiedName": "StockLocationAddress.phone" - }, - "4751": { - "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", - "qualifiedName": "StockLocationAddress.postal_code" + "qualifiedName": "StockLocationAddress" }, "4752": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", - "qualifiedName": "StockLocationAddress.province" + "qualifiedName": "StockLocationAddress.address_1" }, "4753": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", + "qualifiedName": "StockLocationAddress.address_2" + }, + "4754": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", + "qualifiedName": "StockLocationAddress.company" + }, + "4755": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", + "qualifiedName": "StockLocationAddress.city" + }, + "4756": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", + "qualifiedName": "StockLocationAddress.country_code" + }, + "4757": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", + "qualifiedName": "StockLocationAddress.phone" + }, + "4758": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", + "qualifiedName": "StockLocationAddress.postal_code" + }, + "4759": { + "sourceFileName": "../../../packages/medusa/src/api/routes/admin/stock-locations/update-stock-location.ts", + "qualifiedName": "StockLocationAddress.province" + }, + "4760": { "sourceFileName": "../../../packages/medusa/src/types/store.ts", "qualifiedName": "ExtendedStoreDTO" }, - "4754": { + "4761": { "sourceFileName": "../../../packages/medusa/src/types/store.ts", "qualifiedName": "__type" }, - "4755": { + "4762": { "sourceFileName": "../../../packages/medusa/src/types/store.ts", "qualifiedName": "__type.payment_providers" }, - "4756": { + "4763": { "sourceFileName": "../../../packages/medusa/src/types/store.ts", "qualifiedName": "__type.fulfillment_providers" }, - "4757": { + "4764": { "sourceFileName": "../../../packages/medusa/src/types/store.ts", "qualifiedName": "__type.feature_flags" }, - "4758": { + "4765": { "sourceFileName": "../../../packages/medusa/src/types/store.ts", "qualifiedName": "__type.modules" }, - "4759": { + "4766": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "FileServiceUploadResult" }, - "4760": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type" - }, - "4761": { + "4767": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.url" }, - "4762": { + "4768": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.key" }, - "4763": { + "4769": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "PricedVariant" }, - "4764": { + "4770": { "sourceFileName": "../../../packages/medusa/src/types/price-selection.ts", "qualifiedName": "AdminPriceSelectionParams" }, - "4767": { + "4773": { "sourceFileName": "../../../packages/medusa/src/types/price-selection.ts", "qualifiedName": "AdminPriceSelectionParams.customer_id" }, - "4768": { + "4774": { "sourceFileName": "../../../packages/medusa/src/types/price-selection.ts", "qualifiedName": "PriceSelectionParams.cart_id" }, - "4769": { + "4775": { "sourceFileName": "../../../packages/medusa/src/types/price-selection.ts", "qualifiedName": "PriceSelectionParams.region_id" }, - "4770": { + "4776": { "sourceFileName": "../../../packages/medusa/src/types/price-selection.ts", "qualifiedName": "PriceSelectionParams.currency_code" }, - "4771": { + "4777": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", "qualifiedName": "FindParams.expand" }, - "4772": { + "4778": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", "qualifiedName": "FindParams.fields" }, - "4773": { + "4779": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/carts/update-cart.ts", "qualifiedName": "GiftCard" }, - "4776": { + "4782": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/carts/update-cart.ts", "qualifiedName": "GiftCard.code" }, - "4777": { + "4783": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/carts/update-cart.ts", "qualifiedName": "Discount" }, - "4780": { + "4786": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/carts/update-cart.ts", "qualifiedName": "Discount.code" }, - "4781": { + "4787": { "sourceFileName": "../../../packages/medusa/src/types/price-selection.ts", "qualifiedName": "PriceSelectionParams" }, - "4784": { + "4790": { "sourceFileName": "../../../packages/medusa/src/types/price-selection.ts", "qualifiedName": "PriceSelectionParams.cart_id" }, - "4785": { + "4791": { "sourceFileName": "../../../packages/medusa/src/types/price-selection.ts", "qualifiedName": "PriceSelectionParams.region_id" }, - "4786": { + "4792": { "sourceFileName": "../../../packages/medusa/src/types/price-selection.ts", "qualifiedName": "PriceSelectionParams.currency_code" }, - "4787": { + "4793": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", "qualifiedName": "FindParams.expand" }, - "4788": { + "4794": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", "qualifiedName": "FindParams.fields" }, - "4789": { + "4795": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/returns/create-return.ts", "qualifiedName": "Item" }, - "4792": { + "4798": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/returns/create-return.ts", "qualifiedName": "Item.item_id" }, - "4793": { - "sourceFileName": "../../../packages/medusa/src/api/routes/store/returns/create-return.ts", - "qualifiedName": "Item.quantity" - }, - "4794": { - "sourceFileName": "../../../packages/medusa/src/api/routes/store/returns/create-return.ts", - "qualifiedName": "Item.reason_id" - }, - "4795": { - "sourceFileName": "../../../packages/medusa/src/api/routes/store/returns/create-return.ts", - "qualifiedName": "Item.note" - }, - "4796": { - "sourceFileName": "../../../packages/medusa/src/api/routes/store/returns/create-return.ts", - "qualifiedName": "ReturnShipping" - }, "4799": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/returns/create-return.ts", - "qualifiedName": "ReturnShipping.option_id" + "qualifiedName": "Item.quantity" }, "4800": { + "sourceFileName": "../../../packages/medusa/src/api/routes/store/returns/create-return.ts", + "qualifiedName": "Item.reason_id" + }, + "4801": { + "sourceFileName": "../../../packages/medusa/src/api/routes/store/returns/create-return.ts", + "qualifiedName": "Item.note" + }, + "4802": { + "sourceFileName": "../../../packages/medusa/src/api/routes/store/returns/create-return.ts", + "qualifiedName": "ReturnShipping" + }, + "4805": { + "sourceFileName": "../../../packages/medusa/src/api/routes/store/returns/create-return.ts", + "qualifiedName": "ReturnShipping.option_id" + }, + "4806": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "PricedShippingOption" }, - "4801": { + "4807": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/swaps/create-swap.ts", "qualifiedName": "Item" }, - "4804": { + "4810": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/swaps/create-swap.ts", "qualifiedName": "Item.item_id" }, - "4805": { + "4811": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/swaps/create-swap.ts", "qualifiedName": "Item.quantity" }, - "4806": { + "4812": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/swaps/create-swap.ts", "qualifiedName": "Item.reason_id" }, - "4807": { + "4813": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/swaps/create-swap.ts", "qualifiedName": "Item.note" }, - "4808": { + "4814": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/swaps/create-swap.ts", "qualifiedName": "AdditionalItem" }, - "4811": { + "4817": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/swaps/create-swap.ts", "qualifiedName": "AdditionalItem.variant_id" }, - "4812": { + "4818": { "sourceFileName": "../../../packages/medusa/src/api/routes/store/swaps/create-swap.ts", "qualifiedName": "AdditionalItem.quantity" }, - "4813": { - "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "MedusaError" - }, - "4814": { - "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "MedusaError.Types" - }, - "4815": { - "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type" - }, - "4816": { - "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type.DB_ERROR" - }, - "4817": { - "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type.DUPLICATE_ERROR" - }, - "4818": { - "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type.INVALID_ARGUMENT" - }, "4819": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type.INVALID_DATA" + "qualifiedName": "MedusaError" }, "4820": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type.UNAUTHORIZED" + "qualifiedName": "MedusaError.Types" }, "4821": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type.NOT_FOUND" + "qualifiedName": "__type" }, "4822": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type.NOT_ALLOWED" + "qualifiedName": "__type.DB_ERROR" }, "4823": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type.UNEXPECTED_STATE" + "qualifiedName": "__type.DUPLICATE_ERROR" }, "4824": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type.CONFLICT" + "qualifiedName": "__type.INVALID_ARGUMENT" }, "4825": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type.PAYMENT_AUTHORIZATION_ERROR" + "qualifiedName": "__type.INVALID_DATA" }, "4826": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "MedusaError.Codes" + "qualifiedName": "__type.UNAUTHORIZED" }, "4827": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.NOT_FOUND" }, "4828": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type.INSUFFICIENT_INVENTORY" + "qualifiedName": "__type.NOT_ALLOWED" }, "4829": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "__type.CART_INCOMPATIBLE_STATE" + "qualifiedName": "__type.UNEXPECTED_STATE" }, "4830": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "MedusaError.__constructor" + "qualifiedName": "__type.CONFLICT" }, "4831": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "MedusaError" + "qualifiedName": "__type.PAYMENT_AUTHORIZATION_ERROR" }, "4832": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "type" + "qualifiedName": "MedusaError.Codes" }, "4833": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "message" + "qualifiedName": "__type" }, "4834": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "code" + "qualifiedName": "__type.INSUFFICIENT_INVENTORY" }, "4835": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "params" + "qualifiedName": "__type.CART_INCOMPATIBLE_STATE" }, "4836": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "MedusaError.type" + "qualifiedName": "MedusaError.__constructor" }, "4837": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "MedusaError.message" + "qualifiedName": "MedusaError" }, "4838": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "MedusaError.code" + "qualifiedName": "type" }, "4839": { "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", - "qualifiedName": "MedusaError.date" + "qualifiedName": "message" }, "4840": { + "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", + "qualifiedName": "code" + }, + "4841": { + "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", + "qualifiedName": "params" + }, + "4842": { + "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", + "qualifiedName": "MedusaError.type" + }, + "4843": { + "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", + "qualifiedName": "MedusaError.message" + }, + "4844": { + "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", + "qualifiedName": "MedusaError.code" + }, + "4845": { + "sourceFileName": "../../../packages/medusa-core-utils/dist/errors.d.ts", + "qualifiedName": "MedusaError.date" + }, + "4846": { "sourceFileName": "../../../packages/medusa/src/api/middlewares/await-middleware.ts", "qualifiedName": "handler" }, - "4841": { + "4847": { "sourceFileName": "../../../packages/medusa/src/api/middlewares/await-middleware.ts", "qualifiedName": "__type" }, - "4842": { + "4848": { "sourceFileName": "../../../packages/medusa/src/api/middlewares/await-middleware.ts", "qualifiedName": "__type" }, - "4843": { + "4849": { "sourceFileName": "../../../packages/medusa/src/api/middlewares/await-middleware.ts", "qualifiedName": "req" }, - "4844": { + "4850": { "sourceFileName": "../../../packages/medusa/src/api/middlewares/await-middleware.ts", "qualifiedName": "res" }, - "4845": { + "4851": { "sourceFileName": "../../../packages/medusa/src/types/request.ts", "qualifiedName": "RequestContext" }, - "4846": { + "4852": { "sourceFileName": "../../../packages/medusa/src/types/request.ts", "qualifiedName": "__type" }, - "4847": { + "4853": { "sourceFileName": "../../../packages/medusa/src/types/request.ts", "qualifiedName": "__type.ip" }, - "4848": { + "4854": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "DeleteFileType" }, - "4849": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type" - }, - "4850": { + "4855": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.fileKey" }, - "4851": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.__index" - }, - "4853": { + "4856": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "UploadStreamDescriptorType" }, - "4854": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type" - }, - "4855": { + "4857": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.name" }, - "4856": { + "4858": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.ext" }, - "4857": { + "4859": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.isPrivate" }, - "4858": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.__index" - }, "4860": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "FileServiceGetUploadStreamResult" }, "4861": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type" + "qualifiedName": "__type.writeStream" }, "4862": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.writeStream" + "qualifiedName": "__type.promise" }, "4863": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.promise" + "qualifiedName": "__type.url" }, "4864": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.url" + "qualifiedName": "__type.fileKey" }, "4865": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.fileKey" + "qualifiedName": "GetUploadedFileType" }, "4866": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.__index" - }, - "4868": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "GetUploadedFileType" - }, - "4869": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type" - }, - "4870": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.fileKey" }, - "4871": { + "4867": { "sourceFileName": "../../../packages/types/src/file-service/index.ts", "qualifiedName": "__type.isPrivate" }, - "4872": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.__index" + "4868": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "MedusaContainer" }, - "4874": { + "4869": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "__type" + }, + "4879": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", "qualifiedName": "ShippingOptionData" }, - "4875": { + "4880": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", "qualifiedName": "FulfillmentProviderData" }, - "4876": { + "4881": { "sourceFileName": "../../../packages/medusa/src/interfaces/fulfillment-service.ts", "qualifiedName": "ShippingMethodData" }, - "4877": { + "4882": { "sourceFileName": "../../../packages/medusa/src/types/fulfillment-provider.ts", "qualifiedName": "CreateReturnType" }, - "4878": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "4883": { + "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", "qualifiedName": "MedusaContainer" }, - "4879": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type" - }, - "4880": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type.registerAdd" - }, - "4881": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type" - }, - "4882": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type" - }, - "4883": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "name" - }, "4884": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "registration" + "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", + "qualifiedName": "__type" }, "4885": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "T" + "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", + "qualifiedName": "__type.registerAdd" }, "4886": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type.createScope" + "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", + "qualifiedName": "__type" }, "4887": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", "qualifiedName": "__type" }, "4888": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type" - }, - "4889": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "ReturnedData" - }, - "4890": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "__type" - }, - "4891": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "__type.to" - }, - "4892": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "__type.status" - }, - "4893": { - "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", - "qualifiedName": "__type.data" - }, - "4894": { - "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", - "qualifiedName": "MedusaContainer" - }, - "4895": { - "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", - "qualifiedName": "__type" - }, - "4896": { - "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", - "qualifiedName": "__type.registerAdd" - }, - "4897": { - "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", - "qualifiedName": "__type" - }, - "4898": { - "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", - "qualifiedName": "__type" - }, - "4899": { "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", "qualifiedName": "name" }, - "4900": { + "4889": { "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", "qualifiedName": "registration" }, - "4901": { + "4890": { "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", "qualifiedName": "T" }, - "4902": { + "4891": { "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", "qualifiedName": "__type.createScope" }, - "4903": { + "4892": { "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", "qualifiedName": "__type" }, - "4904": { + "4893": { "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", "qualifiedName": "__type" }, - "4905": { + "4894": { "sourceFileName": "../../../packages/medusa/index.d.ts", "qualifiedName": "\"medusa-interfaces\"" }, - "4906": { + "4895": { "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", "qualifiedName": "ITransactionBaseService" }, - "4907": { + "4896": { "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", "qualifiedName": "ITransactionBaseService.withTransaction" }, - "4908": { + "4897": { "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", "qualifiedName": "ITransactionBaseService.withTransaction" }, - "4909": { + "4898": { "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", "qualifiedName": "transactionManager" }, - "4910": { + "4899": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "TaxServiceRate" }, - "4911": { + "4900": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type" }, - "4912": { + "4901": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.rate" }, - "4913": { + "4902": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.name" }, - "4914": { + "4903": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.code" }, - "4915": { + "4904": { "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", "qualifiedName": "DefaultPriceType.DEFAULT" }, - "4916": { + "4905": { "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", "qualifiedName": "DefaultPriceType" }, - "4917": { + "4906": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "LineAllocationsMap" }, - "4918": { + "4907": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type" }, - "4919": { + "4908": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type.__index" }, - "4921": { + "4910": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type" }, - "4922": { + "4911": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type.gift_card" }, - "4923": { + "4912": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type.discount" }, - "4924": { + "4913": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "ProviderTaxLine" }, - "4925": { + "4914": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleJoinerConfig" }, - "4926": { + "4915": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "4927": { + "4916": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.schema" }, - "4928": { + "4917": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.relationships" }, - "4929": { + "4918": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.extends" }, - "4930": { + "4919": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "4931": { + "4920": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.serviceName" }, - "4932": { + "4921": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.fieldAlias" }, - "4933": { + "4922": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "4934": { + "4923": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.path" }, - "4935": { + "4924": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.forwardArgumentsOnPath" }, - "4936": { + "4925": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.relationship" }, - "4937": { + "4926": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.serviceName" }, - "4938": { + "4927": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.primaryKeys" }, - "4939": { + "4928": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isLink" }, - "4940": { + "4929": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.linkableKeys" }, - "4941": { + "4930": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isReadOnlyLink" }, - "4942": { + "4931": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.databaseConfig" }, - "4943": { + "4932": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "4944": { + "4933": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.tableName" }, - "4945": { + "4934": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.idPrefix" }, - "4946": { + "4935": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.extraFields" }, - "4947": { + "4936": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "4948": { + "4937": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.type" }, - "4949": { + "4938": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.defaultValue" }, - "4950": { + "4939": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.nullable" }, - "4951": { + "4940": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.options" }, - "4952": { + "4941": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", "qualifiedName": "InnerSelector" }, - "4953": { + "4942": { "sourceFileName": "../../../packages/medusa/src/types/common.ts", "qualifiedName": "TEntity" }, - "4954": { + "4943": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "ConfigModule" }, - "4955": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type" - }, - "4956": { + "4944": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.projectConfig" }, - "4957": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.featureFlags" - }, - "4958": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.modules" - }, - "4959": { + "4945": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.plugins" }, - "4960": { + "4946": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type" }, - "4961": { + "4947": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.resolve" }, - "4962": { + "4948": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.options" }, - "4963": { + "4949": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.modules" + }, + "4950": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.featureFlags" + }, + "4951": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "MiddlewareVerb" }, - "4964": { + "4952": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "ParserConfig" }, - "4965": { + "4953": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "__type" }, - "4966": { + "4954": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "__type.sizeLimit" }, - "4967": { + "4955": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "MedusaErrorHandlerFunction" }, - "4968": { + "4956": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "__type" }, - "4969": { + "4957": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "__type" }, - "4970": { + "4958": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "error" }, - "4971": { + "4959": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "req" }, - "4972": { + "4960": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "res" }, - "4973": { + "4961": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "next" }, - "4974": { + "4962": { "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", "qualifiedName": "SubscriberContext" }, - "4975": { + "4963": { "sourceFileName": "../../../packages/medusa/src/types/subscribers.ts", "qualifiedName": "SubscriberContext.subscriberId" }, - "4976": { + "4964": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "Constructor" }, - "4977": { + "4965": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "4978": { + "4966": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "4979": { + "4967": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "args" }, - "4980": { + "4968": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "T" }, - "4981": { + "4969": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO" }, - "4982": { + "4970": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.id" }, - "4983": { + "4971": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.title" }, - "4984": { + "4972": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.sku" }, - "4985": { + "4973": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.barcode" }, - "4986": { + "4974": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.ean" }, - "4987": { + "4975": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.upc" }, - "4988": { + "4976": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.inventory_quantity" }, - "4989": { + "4977": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.allow_backorder" }, - "4990": { + "4978": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.manage_inventory" }, - "4991": { + "4979": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.hs_code" }, - "4992": { + "4980": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.origin_country" }, - "4993": { + "4981": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.mid_code" }, - "4994": { + "4982": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.material" }, - "4995": { + "4983": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.weight" }, - "4996": { + "4984": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.length" }, - "4997": { + "4985": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.height" }, - "4998": { + "4986": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.width" }, - "4999": { + "4987": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.options" }, - "5000": { + "4988": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.metadata" }, - "5001": { + "4989": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.product" }, - "5002": { + "4990": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.product_id" }, - "5003": { + "4991": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.variant_rank" }, - "5004": { + "4992": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.created_at" }, - "5005": { + "4993": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.updated_at" }, - "5006": { + "4994": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductVariantDTO.deleted_at" }, - "5007": { + "4995": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", "qualifiedName": "Image" }, - "5010": { + "4998": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", "qualifiedName": "Image.id" }, - "5011": { + "4999": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", "qualifiedName": "Image.url" }, - "5012": { + "5000": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", "qualifiedName": "Tag" }, - "5015": { + "5003": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", "qualifiedName": "Tag.id" }, - "5016": { + "5004": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/orders/update-claim.ts", "qualifiedName": "Tag.value" }, - "5017": { + "5005": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", "qualifiedName": "ProductVariantOptionReq" }, - "5020": { + "5008": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/create-product.ts", "qualifiedName": "ProductVariantOptionReq.value" }, - "5021": { + "5009": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", "qualifiedName": "ProductVariantOptionReq" }, - "5024": { + "5012": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", "qualifiedName": "ProductVariantOptionReq.value" }, - "5025": { + "5013": { "sourceFileName": "../../../packages/medusa/src/api/routes/admin/products/update-product.ts", "qualifiedName": "ProductVariantOptionReq.option_id" }, - "5026": { + "5014": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "StockLocationAddressDTO" }, - "5027": { + "5015": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type" }, - "5028": { + "5016": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.id" }, - "5029": { + "5017": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.address_1" }, - "5030": { + "5018": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.address_2" }, - "5031": { + "5019": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.company" }, - "5032": { + "5020": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.country_code" }, - "5033": { + "5021": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.city" }, - "5034": { + "5022": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.phone" }, - "5035": { + "5023": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.postal_code" }, - "5036": { + "5024": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.province" }, - "5037": { + "5025": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.metadata" }, - "5038": { + "5026": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.created_at" }, - "5039": { + "5027": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.updated_at" }, - "5040": { + "5028": { "sourceFileName": "../../../packages/types/src/stock-location/common.ts", "qualifiedName": "__type.deleted_at" }, - "5041": { + "5029": { "sourceFileName": "../../../packages/medusa/src/types/feature-flags.ts", "qualifiedName": "FeatureFlagsResponse" }, - "5042": { + "5030": { "sourceFileName": "../../../packages/medusa/src/types/feature-flags.ts", "qualifiedName": "__type" }, - "5043": { + "5031": { "sourceFileName": "../../../packages/medusa/src/types/feature-flags.ts", "qualifiedName": "__type.key" }, - "5044": { + "5032": { "sourceFileName": "../../../packages/medusa/src/types/feature-flags.ts", "qualifiedName": "__type.value" }, - "5045": { + "5033": { "sourceFileName": "../../../packages/medusa/src/types/store.ts", "qualifiedName": "ModulesResponse" }, - "5046": { + "5034": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "ProductVariantPricing" }, - "5047": { + "5035": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type" }, - "5048": { + "5036": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.prices" }, - "5049": { + "5037": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.original_price" }, - "5050": { + "5038": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.calculated_price" }, - "5051": { + "5039": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.original_price_includes_tax" }, - "5052": { + "5040": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.calculated_price_includes_tax" }, - "5053": { + "5041": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.calculated_price_type" }, - "5054": { + "5042": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "ShippingOptionPricing" }, - "5055": { + "5043": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type" }, - "5056": { + "5044": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.price_incl_tax" }, - "5057": { + "5045": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.tax_rates" }, - "5058": { + "5046": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.tax_amount" }, - "5059": { + "5047": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "GiftCardAllocation" }, - "5060": { + "5048": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type" }, - "5061": { + "5049": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type.amount" }, - "5062": { + "5050": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type.unit_amount" }, - "5063": { + "5051": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "DiscountAllocation" }, - "5064": { + "5052": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type" }, - "5065": { + "5053": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type.amount" }, - "5066": { + "5054": { "sourceFileName": "../../../packages/medusa/src/types/totals.ts", "qualifiedName": "__type.unit_amount" }, - "5067": { + "5055": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "ProviderLineItemTaxLine" }, - "5068": { + "5056": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type" }, - "5069": { + "5057": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.rate" }, - "5070": { + "5058": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.name" }, - "5071": { + "5059": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.code" }, - "5072": { + "5060": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.item_id" }, - "5073": { + "5061": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.metadata" }, - "5074": { + "5062": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "ProviderShippingMethodTaxLine" }, - "5075": { + "5063": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type" }, - "5076": { + "5064": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.rate" }, - "5077": { + "5065": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.name" }, - "5078": { + "5066": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.code" }, - "5079": { + "5067": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.metadata" }, - "5080": { + "5068": { "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", "qualifiedName": "__type.shipping_method_id" }, - "5081": { + "5069": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig" }, - "5082": { + "5070": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.serviceName" }, - "5083": { + "5071": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.alias" }, - "5084": { + "5072": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.fieldAlias" }, - "5085": { + "5073": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "5086": { + "5074": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.path" }, - "5087": { + "5075": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.forwardArgumentsOnPath" }, - "5088": { + "5076": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.primaryKeys" }, - "5089": { + "5077": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.relationships" }, - "5090": { + "5078": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.extends" }, - "5091": { + "5079": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "5092": { + "5080": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.serviceName" }, - "5093": { + "5081": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.relationship" }, - "5094": { + "5082": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfig.args" }, - "5095": { + "5083": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleJoinerRelationship" }, - "5096": { + "5084": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "5097": { + "5085": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isInternalService" }, - "5098": { + "5086": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.deleteCascade" }, - "5099": { + "5087": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "ProjectConfigOptions" }, + "5088": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.store_cors" + }, + "5089": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.admin_cors" + }, + "5090": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.cookie_secret" + }, + "5091": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.jwt_secret" + }, + "5092": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_database" + }, + "5093": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_url" + }, + "5094": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_schema" + }, + "5095": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_logging" + }, + "5097": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_extra" + }, + "5098": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type" + }, + "5099": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.ssl" + }, "5100": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type" }, "5101": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.redis_url" + "qualifiedName": "__type.rejectUnauthorized" }, "5102": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.redis_prefix" + "qualifiedName": "__type.redis_url" }, "5103": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.redis_options" + "qualifiedName": "__type.redis_prefix" }, "5104": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.session_options" + "qualifiedName": "__type.redis_options" }, "5105": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.jwt_secret" + "qualifiedName": "__type.session_options" }, "5106": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.cookie_secret" - }, - "5107": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.database_url" - }, - "5108": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.database_database" - }, - "5109": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.database_schema" - }, - "5110": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.database_logging" - }, - "5111": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.database_type" - }, - "5112": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.http_compression" }, - "5113": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.database_extra" - }, - "5114": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type" - }, - "5115": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.ssl" - }, - "5116": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type" - }, - "5117": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.rejectUnauthorized" - }, - "5118": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.store_cors" - }, - "5119": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.admin_cors" - }, - "5120": { + "5107": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "InternalModuleDeclaration" }, - "5121": { + "5108": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "5122": { + "5109": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.scope" }, - "5123": { + "5110": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.resources" }, - "5124": { + "5111": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.dependencies" }, - "5125": { + "5112": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.definition" }, - "5126": { + "5113": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.resolve" }, - "5127": { + "5114": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.options" }, - "5128": { + "5115": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.alias" }, - "5129": { + "5116": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.main" }, - "5130": { + "5117": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ExternalModuleDeclaration" }, - "5131": { + "5118": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "5132": { + "5119": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.scope" }, - "5133": { + "5120": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.definition" }, - "5134": { + "5121": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.server" }, - "5135": { + "5122": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "5136": { + "5123": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.type" }, - "5137": { + "5124": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.url" }, - "5138": { + "5125": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.keepAlive" }, - "5139": { + "5126": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.options" }, - "5140": { + "5127": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.alias" }, - "5141": { + "5128": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.main" }, - "5142": { + "5129": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "RouteVerb" }, - "5143": { + "5130": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionValueDTO" }, - "5144": { + "5131": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionValueDTO.id" }, - "5145": { + "5132": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionValueDTO.value" }, - "5146": { + "5133": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionValueDTO.option" }, - "5147": { + "5134": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionValueDTO.variant" }, - "5148": { + "5135": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionValueDTO.metadata" }, - "5149": { + "5136": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionValueDTO.deleted_at" }, - "5150": { + "5137": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO" }, - "5151": { + "5138": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.id" }, - "5152": { + "5139": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.title" }, - "5153": { + "5140": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.handle" }, - "5154": { + "5141": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.subtitle" }, - "5155": { + "5142": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.description" }, - "5156": { + "5143": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.is_giftcard" }, - "5157": { + "5144": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.status" }, - "5158": { + "5145": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.thumbnail" }, - "5159": { + "5146": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.width" }, - "5160": { + "5147": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.weight" }, - "5161": { + "5148": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.length" }, - "5162": { + "5149": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.height" }, - "5163": { + "5150": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.origin_country" }, - "5164": { + "5151": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.hs_code" }, - "5165": { + "5152": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.mid_code" }, - "5166": { + "5153": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.material" }, - "5167": { + "5154": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.collection" }, - "5168": { + "5155": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.categories" }, - "5169": { + "5156": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.type" }, - "5170": { + "5157": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.tags" }, - "5171": { + "5158": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.variants" }, - "5172": { + "5159": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.options" }, - "5173": { + "5160": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.images" }, - "5174": { + "5161": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.discountable" }, - "5175": { + "5162": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.external_id" }, - "5176": { + "5163": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.created_at" }, - "5177": { + "5164": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.updated_at" }, - "5178": { + "5165": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.deleted_at" }, - "5179": { + "5166": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductDTO.metadata" }, - "5180": { + "5167": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModulesResponse" }, - "5181": { + "5168": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "5182": { + "5169": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.module" }, - "5183": { + "5170": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.resolution" }, - "5184": { + "5171": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "TaxedPricing" }, - "5185": { + "5172": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type" }, - "5186": { + "5173": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.original_price_incl_tax" }, - "5187": { + "5174": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.calculated_price_incl_tax" }, - "5188": { + "5175": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.original_tax" }, - "5189": { + "5176": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.calculated_tax" }, - "5190": { + "5177": { "sourceFileName": "../../../packages/medusa/src/types/pricing.ts", "qualifiedName": "__type.tax_rates" }, - "5191": { + "5178": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfigAlias" }, - "5192": { + "5179": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfigAlias.name" }, - "5193": { + "5180": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerServiceConfigAlias.args" }, - "5194": { + "5181": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "JoinerRelationship" }, - "5195": { + "5182": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type" }, - "5196": { + "5183": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.alias" }, - "5197": { + "5184": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.foreignKey" }, - "5198": { + "5185": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.primaryKey" }, - "5199": { + "5186": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.serviceName" }, - "5200": { + "5187": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.isInternalService" }, - "5201": { + "5188": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.inverse" }, - "5202": { + "5189": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.isList" }, - "5203": { + "5190": { "sourceFileName": "../../../packages/types/src/joiner/index.ts", "qualifiedName": "__type.args" }, - "5204": { + "5191": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "SessionOptions" }, - "5205": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type" - }, - "5206": { + "5192": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.name" }, - "5207": { + "5193": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.resave" }, - "5208": { + "5194": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.rolling" }, - "5209": { + "5195": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.saveUninitialized" }, - "5210": { + "5196": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.secret" }, - "5211": { + "5197": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.ttl" }, - "5212": { + "5198": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "HttpCompressionOptions" }, - "5213": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type" - }, - "5214": { + "5199": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.enabled" }, - "5215": { + "5200": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.level" }, - "5216": { + "5201": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.memLevel" }, - "5217": { + "5202": { "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type.threshold" }, - "5218": { + "5203": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "MODULE_SCOPE.INTERNAL" }, - "5219": { + "5204": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "MODULE_RESOURCE_TYPE" }, - "5220": { + "5205": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "MODULE_RESOURCE_TYPE.SHARED" }, - "5221": { + "5206": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "MODULE_RESOURCE_TYPE.ISOLATED" }, - "5222": { + "5207": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "ModuleDefinition" }, - "5223": { + "5208": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, - "5224": { + "5209": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.key" }, - "5225": { + "5210": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.registrationName" }, - "5226": { + "5211": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.defaultPackage" }, - "5227": { + "5212": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.label" }, - "5228": { + "5213": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.canOverride" }, - "5229": { + "5214": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isRequired" }, - "5230": { + "5215": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isQueryable" }, - "5231": { + "5216": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.isLegacy" }, - "5232": { + "5217": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.dependencies" }, - "5233": { + "5218": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type.defaultModuleDeclaration" }, - "5234": { + "5219": { "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "MODULE_SCOPE.EXTERNAL" }, - "5235": { + "5220": { "sourceFileName": "../../../packages/medusa/src/loaders/helpers/routing/types.ts", "qualifiedName": "HTTP_METHODS" }, - "5236": { + "5221": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionDTO" }, - "5237": { + "5222": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionDTO.id" }, - "5238": { + "5223": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionDTO.title" }, - "5239": { + "5224": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionDTO.product" }, - "5240": { + "5225": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionDTO.values" }, - "5241": { + "5226": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionDTO.metadata" }, - "5242": { + "5227": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductOptionDTO.deleted_at" }, - "5243": { + "5228": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductStatus" }, - "5244": { + "5229": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductStatus.DRAFT" }, - "5245": { + "5230": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductStatus.PROPOSED" }, - "5246": { + "5231": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductStatus.PUBLISHED" }, - "5247": { + "5232": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductStatus.REJECTED" }, - "5248": { + "5233": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCollectionDTO" }, - "5249": { + "5234": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCollectionDTO.id" }, - "5250": { + "5235": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCollectionDTO.title" }, - "5251": { + "5236": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCollectionDTO.handle" }, - "5252": { + "5237": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCollectionDTO.metadata" }, - "5253": { + "5238": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCollectionDTO.deleted_at" }, - "5254": { + "5239": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCollectionDTO.products" }, - "5255": { + "5240": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCategoryDTO" }, - "5256": { + "5241": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCategoryDTO.id" }, - "5257": { + "5242": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCategoryDTO.name" }, - "5258": { + "5243": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCategoryDTO.description" }, - "5259": { + "5244": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCategoryDTO.handle" }, - "5260": { + "5245": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCategoryDTO.is_active" }, - "5261": { + "5246": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCategoryDTO.is_internal" }, - "5262": { + "5247": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCategoryDTO.rank" }, - "5263": { + "5248": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCategoryDTO.parent_category" }, - "5264": { + "5249": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCategoryDTO.category_children" }, - "5265": { + "5250": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCategoryDTO.created_at" }, - "5266": { + "5251": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductCategoryDTO.updated_at" }, - "5267": { + "5252": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductTypeDTO" }, - "5268": { + "5253": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductTypeDTO.id" }, - "5269": { + "5254": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductTypeDTO.value" }, - "5270": { + "5255": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductTypeDTO.metadata" }, - "5271": { + "5256": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductTypeDTO.deleted_at" }, - "5272": { + "5257": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductTagDTO" }, - "5273": { + "5258": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductTagDTO.id" }, - "5274": { + "5259": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductTagDTO.value" }, - "5275": { + "5260": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductTagDTO.metadata" }, - "5276": { + "5261": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductTagDTO.products" }, - "5277": { + "5262": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductImageDTO" }, - "5278": { + "5263": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductImageDTO.id" }, - "5279": { + "5264": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductImageDTO.url" }, - "5280": { + "5265": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductImageDTO.metadata" }, - "5281": { + "5266": { "sourceFileName": "../../../packages/types/src/product/common.ts", "qualifiedName": "ProductImageDTO.deleted_at" } diff --git a/docs-util/typedoc-json-output/0-types.json b/docs-util/typedoc-json-output/0-types.json index 4a06f191d7..a8be2a8c6a 100644 --- a/docs-util/typedoc-json-output/0-types.json +++ b/docs-util/typedoc-json-output/0-types.json @@ -5,6 +5,1415 @@ "kind": 1, "flags": {}, "children": [ + { + "id": 1, + "name": "AddressDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 3, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 5, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 6, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 7, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 8, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 9, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 10, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 11, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 12, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 13, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 14, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 15, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + { + "type": "literal", + "value": null + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15 + ] + } + ] + } + } + }, + { + "id": 115, + "name": "AuthProviderDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 116, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 117, + "name": "provider", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 118, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 119, + "name": "domain", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 133, + "name": "ProviderDomain", + "package": "@medusajs/types" + } + }, + { + "id": 120, + "name": "is_active", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 117, + 118, + 119, + 120 + ] + } + ] + } + } + }, + { + "id": 121, + "name": "CreateAuthProviderDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 122, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 123, + "name": "provider", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 124, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 125, + "name": "domain", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 133, + "name": "ProviderDomain", + "package": "@medusajs/types" + } + }, + { + "id": 126, + "name": "is_active", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 123, + 124, + 125, + 126 + ] + } + ] + } + } + }, + { + "id": 127, + "name": "UpdateAuthProviderDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 128, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 129, + "name": "provider", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 130, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 131, + "name": "domain", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 133, + "name": "ProviderDomain", + "package": "@medusajs/types" + } + }, + { + "id": 132, + "name": "is_active", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 129, + 130, + 131, + 132 + ] + } + ] + } + } + }, + { + "id": 133, + "name": "ProviderDomain", + "variant": "declaration", + "kind": 8, + "flags": {}, + "children": [ + { + "id": 134, + "name": "ALL", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "all" + } + }, + { + "id": 135, + "name": "STORE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "store" + } + }, + { + "id": 136, + "name": "ADMIN", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "admin" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 134, + 135, + 136 + ] + } + ] + }, + { + "id": 137, + "name": "FilterableAuthProviderProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 138, + "name": "provider", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 139, + "name": "is_active", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 140, + "name": "domain", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 133, + "name": "ProviderDomain", + "package": "@medusajs/types" + } + } + }, + { + "id": 141, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 142, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 137, + "name": "FilterableAuthProviderProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 137, + "name": "FilterableAuthProviderProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 143, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 137, + "name": "FilterableAuthProviderProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 137, + "name": "FilterableAuthProviderProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 138, + 139, + 140, + 141, + 142, + 143 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 137, + "name": "FilterableAuthProviderProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 90, + "name": "AuthUserDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 91, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 92, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 93, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 94, + "name": "provider", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 115, + "name": "AuthProviderDTO", + "package": "@medusajs/types" + } + }, + { + "id": 95, + "name": "provider_metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 96, + "name": "user_metadata", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 97, + "name": "app_metadata", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 92, + 93, + 94, + 95, + 96, + 97 + ] + } + ] + } + } + }, + { + "id": 98, + "name": "CreateAuthUserDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 99, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 100, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 101, + "name": "provider_metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 102, + "name": "user_metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 103, + "name": "app_metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 100, + 101, + 102, + 103 + ] + } + ] + } + } + }, + { + "id": 104, + "name": "UpdateAuthUserDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 105, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 106, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 107, + "name": "provider_metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 108, + "name": "user_metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 109, + "name": "app_metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 106, + 107, + 108, + 109 + ] + } + ] + } + } + }, + { + "id": 110, + "name": "FilterableAuthUserProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 111, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 112, + "name": "provider", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 113, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 110, + "name": "FilterableAuthUserProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 110, + "name": "FilterableAuthUserProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 114, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 110, + "name": "FilterableAuthUserProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 110, + "name": "FilterableAuthUserProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 111, + 112, + 113, + 114 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 110, + "name": "FilterableAuthUserProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, { "id": 152, "name": "AuthenticationTypes", @@ -12,6 +1421,1484 @@ "kind": 4, "flags": {} }, + { + "id": 144, + "name": "AbstractAuthenticationModuleProvider", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 145, + "name": "PROVIDER", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true, + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 146, + "name": "DISPLAY_NAME", + "variant": "declaration", + "kind": 1024, + "flags": { + "isPublic": true, + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 147, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": {}, + "signatures": [ + { + "id": 148, + "name": "new AbstractAuthenticationModuleProvider", + "variant": "signature", + "kind": 16384, + "flags": {}, + "type": { + "type": "reference", + "target": 144, + "name": "AbstractAuthenticationModuleProvider", + "package": "@medusajs/types" + } + } + ] + }, + { + "id": 149, + "name": "authenticate", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 150, + "name": "authenticate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 151, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 147 + ] + }, + { + "title": "Properties", + "children": [ + 145, + 146 + ] + }, + { + "title": "Methods", + "children": [ + 149 + ] + } + ] + }, + { + "id": 16, + "name": "IAuthenticationModuleService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 17, + "name": "retrieveAuthProvider", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 18, + "name": "retrieveAuthProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 19, + "name": "provider", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 20, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 115, + "name": "AuthProviderDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 21, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 115, + "name": "AuthProviderDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 22, + "name": "listAuthProviders", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 23, + "name": "listAuthProviders", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 24, + "name": "filters", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 137, + "name": "FilterableAuthProviderProps", + "package": "@medusajs/types" + } + }, + { + "id": 25, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 115, + "name": "AuthProviderDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 26, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 115, + "name": "AuthProviderDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 27, + "name": "listAndCountAuthProviders", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 28, + "name": "listAndCountAuthProviders", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 29, + "name": "filters", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 137, + "name": "FilterableAuthProviderProps", + "package": "@medusajs/types" + } + }, + { + "id": 30, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 115, + "name": "AuthProviderDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 31, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "tuple", + "elements": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 115, + "name": "AuthProviderDTO", + "package": "@medusajs/types" + } + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 32, + "name": "createAuthProvider", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 33, + "name": "createAuthProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 34, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 121, + "name": "CreateAuthProviderDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 35, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 115, + "name": "AuthProviderDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 36, + "name": "createAuthProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 37, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 121, + "name": "CreateAuthProviderDTO", + "package": "@medusajs/types" + } + }, + { + "id": 38, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 115, + "name": "AuthProviderDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 39, + "name": "updateAuthProvider", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 40, + "name": "updateAuthProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 41, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 127, + "name": "UpdateAuthProviderDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 42, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 115, + "name": "AuthProviderDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 43, + "name": "updateAuthProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 44, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 127, + "name": "UpdateAuthProviderDTO", + "package": "@medusajs/types" + } + }, + { + "id": 45, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 115, + "name": "AuthProviderDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 46, + "name": "deleteAuthProvider", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 47, + "name": "deleteAuthProvider", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 48, + "name": "ids", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 49, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 50, + "name": "retrieveAuthUser", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 51, + "name": "retrieveAuthUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 52, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 53, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 90, + "name": "AuthUserDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 54, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 90, + "name": "AuthUserDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 55, + "name": "listAuthUsers", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 56, + "name": "listAuthUsers", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 57, + "name": "filters", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 137, + "name": "FilterableAuthProviderProps", + "package": "@medusajs/types" + } + }, + { + "id": 58, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 90, + "name": "AuthUserDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 59, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 90, + "name": "AuthUserDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 60, + "name": "listAndCountAuthUsers", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 61, + "name": "listAndCountAuthUsers", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 62, + "name": "filters", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 110, + "name": "FilterableAuthUserProps", + "package": "@medusajs/types" + } + }, + { + "id": 63, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 90, + "name": "AuthUserDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 64, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "tuple", + "elements": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 90, + "name": "AuthUserDTO", + "package": "@medusajs/types" + } + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 65, + "name": "createAuthUser", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 66, + "name": "createAuthUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 67, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 98, + "name": "CreateAuthUserDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 68, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 90, + "name": "AuthUserDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 69, + "name": "createAuthUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 70, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 98, + "name": "CreateAuthUserDTO", + "package": "@medusajs/types" + } + }, + { + "id": 71, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 90, + "name": "AuthUserDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 72, + "name": "updateAuthUser", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 73, + "name": "updateAuthUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 74, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 104, + "name": "UpdateAuthUserDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 75, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 90, + "name": "AuthUserDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 76, + "name": "updateAuthUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 77, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 104, + "name": "UpdateAuthUserDTO", + "package": "@medusajs/types" + } + }, + { + "id": 78, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 90, + "name": "AuthUserDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 79, + "name": "deleteAuthUser", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 80, + "name": "deleteAuthUser", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 81, + "name": "ids", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 82, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 83, + "name": "__joinerConfig", + "variant": "declaration", + "kind": 2048, + "flags": { + "isOptional": true + }, + "signatures": [ + { + "id": 84, + "name": "__joinerConfig", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reference", + "target": 1219, + "name": "ModuleJoinerConfig", + "package": "@medusajs/types" + }, + "inheritedFrom": { + "type": "reference", + "target": 1293, + "name": "IModuleService.__joinerConfig" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 1292, + "name": "IModuleService.__joinerConfig" + } + }, + { + "id": 85, + "name": "__hooks", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 86, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 87, + "name": "onApplicationStart", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 88, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 89, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 87 + ] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 1294, + "name": "IModuleService.__hooks" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 85 + ] + }, + { + "title": "Methods", + "children": [ + 17, + 22, + 27, + 32, + 39, + 46, + 50, + 55, + 60, + 65, + 72, + 79, + 83 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 1291, + "name": "IModuleService", + "package": "@medusajs/types" + } + ] + }, { "id": 153, "name": "CacheTypes", @@ -91,50 +2978,6 @@ } ] }, - { - "id": 164, - "name": "invalidate", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 165, - "name": "invalidate", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 166, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, { "id": 159, "name": "set", @@ -202,6 +3045,50 @@ } } ] + }, + { + "id": 164, + "name": "invalidate", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 165, + "name": "invalidate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 166, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] } ], "groups": [ @@ -209,8 +3096,8 @@ "title": "Methods", "children": [ 155, - 164, - 159 + 159, + 164 ] } ] @@ -233,14 +3120,9791 @@ "flags": {}, "children": [ { - "id": 195, - "name": "ICartModuleService", + "id": 168, + "name": "AdjustmentLineDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 169, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the adjustment line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 170, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the adjustment line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 171, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of the adjustment line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 172, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the adjustment line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 173, + "name": "promotion_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated promotion" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 174, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated provider" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 175, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the adjustment line was created" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 176, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the adjustment line was updated" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 169, + 170, + 171, + 172, + 173, + 174, + 175, + 176 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 177, + "name": "ShippingMethodAdjustmentLineDTO" + }, + { + "type": "reference", + "target": 187, + "name": "LineItemAdjustmentLineDTO" + } + ] + }, + { + "id": 177, + "name": "ShippingMethodAdjustmentLineDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 179, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the adjustment line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 169, + "name": "AdjustmentLineDTO.id" + } + }, + { + "id": 180, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the adjustment line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 170, + "name": "AdjustmentLineDTO.code" + } + }, + { + "id": 181, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of the adjustment line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "target": 171, + "name": "AdjustmentLineDTO.amount" + } + }, + { + "id": 182, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the adjustment line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 172, + "name": "AdjustmentLineDTO.description" + } + }, + { + "id": 183, + "name": "promotion_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated promotion" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 173, + "name": "AdjustmentLineDTO.promotion_id" + } + }, + { + "id": 184, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated provider" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 174, + "name": "AdjustmentLineDTO.provider_id" + } + }, + { + "id": 185, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the adjustment line was created" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 175, + "name": "AdjustmentLineDTO.created_at" + } + }, + { + "id": 186, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the adjustment line was updated" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 176, + "name": "AdjustmentLineDTO.updated_at" + } + }, + { + "id": 178, + "name": "shipping_method", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated shipping method" + } + ] + }, + "type": { + "type": "reference", + "target": 242, + "name": "CartShippingMethodDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 179, + 180, + 181, + 182, + 183, + 184, + 185, + 186, + 178 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 168, + "name": "AdjustmentLineDTO", + "package": "@medusajs/types" + } + ] + }, + { + "id": 187, + "name": "LineItemAdjustmentLineDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 189, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the adjustment line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 169, + "name": "AdjustmentLineDTO.id" + } + }, + { + "id": 190, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the adjustment line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 170, + "name": "AdjustmentLineDTO.code" + } + }, + { + "id": 191, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of the adjustment line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "target": 171, + "name": "AdjustmentLineDTO.amount" + } + }, + { + "id": 192, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the adjustment line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 172, + "name": "AdjustmentLineDTO.description" + } + }, + { + "id": 193, + "name": "promotion_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated promotion" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 173, + "name": "AdjustmentLineDTO.promotion_id" + } + }, + { + "id": 194, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated provider" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 174, + "name": "AdjustmentLineDTO.provider_id" + } + }, + { + "id": 195, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the adjustment line was created" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 175, + "name": "AdjustmentLineDTO.created_at" + } + }, + { + "id": 196, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the adjustment line was updated" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 176, + "name": "AdjustmentLineDTO.updated_at" + } + }, + { + "id": 188, + "name": "line_item", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated line item" + } + ] + }, + "type": { + "type": "reference", + "target": 263, + "name": "CartLineItemDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 189, + 190, + 191, + 192, + 193, + 194, + 195, + 196, + 188 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 168, + "name": "AdjustmentLineDTO", + "package": "@medusajs/types" + } + ] + }, + { + "id": 197, + "name": "TaxLineDTO", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { "id": 198, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the tax line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 199, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the tax line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 200, + "name": "tax_rate_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated tax rate" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 201, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the tax line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 202, + "name": "rate", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rate of the tax line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 203, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated provider" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 204, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the tax line was created" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 205, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the tax line was updated" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 198, + 199, + 200, + 201, + 202, + 203, + 204, + 205 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 206, + "name": "ShippingMethodTaxLineDTO" + }, + { + "type": "reference", + "target": 216, + "name": "LineItemTaxLineDTO" + } + ] + }, + { + "id": 206, + "name": "ShippingMethodTaxLineDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 208, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the tax line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 198, + "name": "TaxLineDTO.id" + } + }, + { + "id": 209, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the tax line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 199, + "name": "TaxLineDTO.description" + } + }, + { + "id": 210, + "name": "tax_rate_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated tax rate" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 200, + "name": "TaxLineDTO.tax_rate_id" + } + }, + { + "id": 211, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the tax line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 201, + "name": "TaxLineDTO.code" + } + }, + { + "id": 212, + "name": "rate", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rate of the tax line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "target": 202, + "name": "TaxLineDTO.rate" + } + }, + { + "id": 213, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated provider" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 203, + "name": "TaxLineDTO.provider_id" + } + }, + { + "id": 214, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the tax line was created" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 204, + "name": "TaxLineDTO.created_at" + } + }, + { + "id": 215, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the tax line was updated" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 205, + "name": "TaxLineDTO.updated_at" + } + }, + { + "id": 207, + "name": "shipping_method", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated shipping method" + } + ] + }, + "type": { + "type": "reference", + "target": 242, + "name": "CartShippingMethodDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 208, + 209, + 210, + 211, + 212, + 213, + 214, + 215, + 207 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 197, + "name": "TaxLineDTO", + "package": "@medusajs/types" + } + ] + }, + { + "id": 216, + "name": "LineItemTaxLineDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 218, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the tax line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 198, + "name": "TaxLineDTO.id" + } + }, + { + "id": 219, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the tax line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 199, + "name": "TaxLineDTO.description" + } + }, + { + "id": 220, + "name": "tax_rate_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated tax rate" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 200, + "name": "TaxLineDTO.tax_rate_id" + } + }, + { + "id": 221, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the tax line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 201, + "name": "TaxLineDTO.code" + } + }, + { + "id": 222, + "name": "rate", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rate of the tax line" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "target": 202, + "name": "TaxLineDTO.rate" + } + }, + { + "id": 223, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated provider" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 203, + "name": "TaxLineDTO.provider_id" + } + }, + { + "id": 224, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the tax line was created" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 204, + "name": "TaxLineDTO.created_at" + } + }, + { + "id": 225, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the tax line was updated" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 205, + "name": "TaxLineDTO.updated_at" + } + }, + { + "id": 217, + "name": "line_item", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated line item" + } + ] + }, + "type": { + "type": "reference", + "target": 263, + "name": "CartLineItemDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 218, + 219, + 220, + 221, + 222, + 223, + 224, + 225, + 217 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 197, + "name": "TaxLineDTO", + "package": "@medusajs/types" + } + ] + }, + { + "id": 226, + "name": "CartAddressDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 227, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 228, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The customer ID of the address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 229, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The first name of the address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 230, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The last name of the address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 231, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The phone number of the address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 232, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The company of the address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 233, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The first address line of the address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 234, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The second address line of the address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 235, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The city of the address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 236, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The country code of the address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 237, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The province/state of the address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 238, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The postal code of the address" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 239, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds custom data in key-value pairs." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + }, + { + "id": 240, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the address was created." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 241, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the address was updated." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 227, + 228, + 229, + 230, + 231, + 232, + 233, + 234, + 235, + 236, + 237, + 238, + 239, + 240, + 241 + ] + } + ] + }, + { + "id": 242, + "name": "CartShippingMethodDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 243, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the shipping method" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 244, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the shipping method" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 245, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The description of the shipping method" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 246, + "name": "unit_price", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price of the shipping method" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 247, + "name": "is_tax_inclusive", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the shipping method price is tax inclusive or not" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 248, + "name": "shipping_option_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the shipping option the method was created from" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 249, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Additional data needed for fulfillment." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 250, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds custom data in key-value pairs." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + }, + { + "id": 251, + "name": "tax_lines", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated tax lines." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 206, + "name": "ShippingMethodTaxLineDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 252, + "name": "adjustments", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated adjustments." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 177, + "name": "ShippingMethodAdjustmentLineDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 253, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the shipping method was created." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 254, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the shipping method was updated." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 255, + "name": "original_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 256, + "name": "original_subtotal", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 257, + "name": "original_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 258, + "name": "total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 259, + "name": "subtotal", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 260, + "name": "tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 261, + "name": "discount_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 262, + "name": "discount_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 243, + 244, + 245, + 246, + 247, + 248, + 249, + 250, + 251, + 252, + 253, + 254, + 255, + 256, + 257, + 258, + 259, + 260, + 261, + 262 + ] + } + ] + }, + { + "id": 263, + "name": "CartLineItemDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 264, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 265, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 266, + "name": "subtitle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The subtitle of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 267, + "name": "thumbnail", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The url of the line item thumbnail." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 268, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item quantity" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 269, + "name": "product_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product ID of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 270, + "name": "product_title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product title of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 271, + "name": "product_description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product description of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 272, + "name": "product_subtitle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product subtitle of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 273, + "name": "product_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product type of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 274, + "name": "product_collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product collection of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 275, + "name": "product_handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The product handle of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 276, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The variant ID of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 277, + "name": "variant_sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The variant sku of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 278, + "name": "variant_barcode", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The variant barcode of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 279, + "name": "variant_title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The variant title of the line item." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 280, + "name": "variant_option_values", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The variant option values of the line item." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 281, + "name": "requires_shipping", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the line item requires shipping or not" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 282, + "name": "is_discountable", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the line item is discountable or not" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 283, + "name": "is_tax_inclusive", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the line item price is tax inclusive or not" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 284, + "name": "compare_at_unit_price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The original price of the item before an adjustment or a sale." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 285, + "name": "unit_price", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price of the item" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 286, + "name": "tax_lines", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated tax lines." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 216, + "name": "LineItemTaxLineDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 287, + "name": "adjustments", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated adjustments." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 187, + "name": "LineItemAdjustmentLineDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 288, + "name": "cart", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated cart." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 304, + "name": "CartDTO", + "package": "@medusajs/types" + } + }, + { + "id": 289, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 290, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds custom data in key-value pairs." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + }, + { + "id": 291, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the line item was created." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 292, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the line item was updated." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 293, + "name": "original_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 294, + "name": "original_subtotal", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 295, + "name": "original_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 296, + "name": "item_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 297, + "name": "item_subtotal", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 298, + "name": "item_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 299, + "name": "total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 300, + "name": "subtotal", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 301, + "name": "tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 302, + "name": "discount_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 303, + "name": "discount_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 264, + 265, + 266, + 267, + 268, + 269, + 270, + 271, + 272, + 273, + 274, + 275, + 276, + 277, + 278, + 279, + 280, + 281, + 282, + 283, + 284, + 285, + 286, + 287, + 288, + 289, + 290, + 291, + 292, + 293, + 294, + 295, + 296, + 297, + 298, + 299, + 300, + 301, + 302, + 303 + ] + } + ] + }, + { + "id": 304, + "name": "CartDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 305, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 306, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the region the cart belongs to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 307, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the customer on the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 308, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the sales channel the cart belongs to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 309, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The email of the cart." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 310, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currency of the cart" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 311, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated shipping address." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 226, + "name": "CartAddressDTO", + "package": "@medusajs/types" + } + }, + { + "id": 312, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated billing address." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 226, + "name": "CartAddressDTO", + "package": "@medusajs/types" + } + }, + { + "id": 313, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated line items." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 263, + "name": "CartLineItemDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 314, + "name": "shipping_methods", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated shipping methods" + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 242, + "name": "CartShippingMethodDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 315, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Holds custom data in key-value pairs." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + }, + { + "id": 316, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the cart was created." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 317, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the cart was updated." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 318, + "name": "original_item_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 319, + "name": "original_item_subtotal", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 320, + "name": "original_item_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 321, + "name": "item_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 322, + "name": "item_subtotal", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 323, + "name": "item_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 324, + "name": "original_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 325, + "name": "original_subtotal", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 326, + "name": "original_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 327, + "name": "total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 328, + "name": "subtotal", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 329, + "name": "tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 330, + "name": "discount_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 331, + "name": "discount_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 332, + "name": "shipping_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 333, + "name": "shipping_subtotal", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 334, + "name": "shipping_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 335, + "name": "original_shipping_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 336, + "name": "original_shipping_subtotal", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 337, + "name": "original_shipping_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 305, + 306, + 307, + 308, + 309, + 310, + 311, + 312, + 313, + 314, + 315, + 316, + 317, + 318, + 319, + 320, + 321, + 322, + 323, + 324, + 325, + 326, + 327, + 328, + 329, + 330, + 331, + 332, + 333, + 334, + 335, + 336, + 337 + ] + } + ] + }, + { + "id": 338, + "name": "FilterableCartProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 339, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 340, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 2254, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "OperatorMap", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 341, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 2254, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "OperatorMap", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 342, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "reference", + "target": 2254, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "OperatorMap", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 343, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2254, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "OperatorMap", + "package": "@medusajs/types" + } + }, + { + "id": 344, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2254, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "OperatorMap", + "package": "@medusajs/types" + } + }, + { + "id": 345, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 338, + "name": "FilterableCartProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 338, + "name": "FilterableCartProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 346, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 338, + "name": "FilterableCartProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 338, + "name": "FilterableCartProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 339, + 340, + 341, + 342, + 343, + 344, + 345, + 346 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 338, + "name": "FilterableCartProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 347, + "name": "FilterableAddressProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 348, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 349, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 347, + "name": "FilterableAddressProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 347, + "name": "FilterableAddressProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 350, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 347, + "name": "FilterableAddressProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 347, + "name": "FilterableAddressProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 348, + 349, + 350 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 347, + "name": "FilterableAddressProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 351, + "name": "FilterableLineItemProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 352, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 353, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 354, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 355, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 356, + "name": "product_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 357, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 351, + "name": "FilterableLineItemProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 351, + "name": "FilterableLineItemProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 358, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 351, + "name": "FilterableLineItemProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 351, + "name": "FilterableLineItemProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 352, + 353, + 354, + 355, + 356, + 357, + 358 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 351, + "name": "FilterableLineItemProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 359, + "name": "legacy_CartDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "TODO: Remove this in favor of CartDTO, when module is released" + } + ], + "blockTags": [ + { + "tag": "@deprecated", + "content": [ + { + "kind": "text", + "text": "Use CartDTO instead" + } + ] + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 360, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 361, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 362, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 363, + "name": "billing_address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 364, + "name": "shipping_address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 365, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 366, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 367, + "name": "payment_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 368, + "name": "completed_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 369, + "name": "payment_authorized_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 370, + "name": "idempotency_key", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 371, + "name": "context", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 372, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 373, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 374, + "name": "shipping_total", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 375, + "name": "discount_total", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 376, + "name": "raw_discount_total", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 377, + "name": "item_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 378, + "name": "shipping_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 379, + "name": "tax_total", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 380, + "name": "refunded_total", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 381, + "name": "total", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 382, + "name": "subtotal", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 383, + "name": "refundable_amount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 384, + "name": "gift_card_total", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 385, + "name": "gift_card_tax_total", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 361, + 362, + 363, + 364, + 365, + 366, + 367, + 368, + 369, + 370, + 371, + 372, + 373, + 374, + 375, + 376, + 377, + 378, + 379, + 380, + 381, + 382, + 383, + 384, + 385 + ] + } + ] + } + } + }, + { + "id": 386, + "name": "UpsertAddressDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 387, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 388, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 389, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 390, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 391, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 392, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 393, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 394, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 395, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 396, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 397, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 398, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 387, + 388, + 389, + 390, + 391, + 392, + 393, + 394, + 395, + 396, + 397, + 398 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 399, + "name": "UpdateAddressDTO" + }, + { + "type": "reference", + "target": 413, + "name": "CreateAddressDTO" + } + ] + }, + { + "id": 399, + "name": "UpdateAddressDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 401, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 387, + "name": "UpsertAddressDTO.customer_id" + } + }, + { + "id": 402, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 388, + "name": "UpsertAddressDTO.company" + } + }, + { + "id": 403, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 389, + "name": "UpsertAddressDTO.first_name" + } + }, + { + "id": 404, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 390, + "name": "UpsertAddressDTO.last_name" + } + }, + { + "id": 405, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 391, + "name": "UpsertAddressDTO.address_1" + } + }, + { + "id": 406, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 392, + "name": "UpsertAddressDTO.address_2" + } + }, + { + "id": 407, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 393, + "name": "UpsertAddressDTO.city" + } + }, + { + "id": 408, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 394, + "name": "UpsertAddressDTO.country_code" + } + }, + { + "id": 409, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 395, + "name": "UpsertAddressDTO.province" + } + }, + { + "id": 410, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 396, + "name": "UpsertAddressDTO.postal_code" + } + }, + { + "id": 411, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 397, + "name": "UpsertAddressDTO.phone" + } + }, + { + "id": 412, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 398, + "name": "UpsertAddressDTO.metadata" + } + }, + { + "id": 400, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 401, + 402, + 403, + 404, + 405, + 406, + 407, + 408, + 409, + 410, + 411, + 412, + 400 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 386, + "name": "UpsertAddressDTO", + "package": "@medusajs/types" + } + ] + }, + { + "id": 413, + "name": "CreateAddressDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 414, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 387, + "name": "UpsertAddressDTO.customer_id" + } + }, + { + "id": 415, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 388, + "name": "UpsertAddressDTO.company" + } + }, + { + "id": 416, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 389, + "name": "UpsertAddressDTO.first_name" + } + }, + { + "id": 417, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 390, + "name": "UpsertAddressDTO.last_name" + } + }, + { + "id": 418, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 391, + "name": "UpsertAddressDTO.address_1" + } + }, + { + "id": 419, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 392, + "name": "UpsertAddressDTO.address_2" + } + }, + { + "id": 420, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 393, + "name": "UpsertAddressDTO.city" + } + }, + { + "id": 421, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 394, + "name": "UpsertAddressDTO.country_code" + } + }, + { + "id": 422, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 395, + "name": "UpsertAddressDTO.province" + } + }, + { + "id": 423, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 396, + "name": "UpsertAddressDTO.postal_code" + } + }, + { + "id": 424, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 397, + "name": "UpsertAddressDTO.phone" + } + }, + { + "id": 425, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 398, + "name": "UpsertAddressDTO.metadata" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 414, + 415, + 416, + 417, + 418, + 419, + 420, + 421, + 422, + 423, + 424, + 425 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 386, + "name": "UpsertAddressDTO", + "package": "@medusajs/types" + } + ] + }, + { + "id": 426, + "name": "CreateCartDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 427, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 428, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 429, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 430, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 431, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 432, + "name": "shipping_address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 433, + "name": "billing_address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 434, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 399, + "name": "UpdateAddressDTO", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 413, + "name": "CreateAddressDTO", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 435, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 399, + "name": "UpdateAddressDTO", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 413, + "name": "CreateAddressDTO", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 436, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 427, + 428, + 429, + 430, + 431, + 432, + 433, + 434, + 435, + 436 + ] + } + ] + }, + { + "id": 437, + "name": "UpdateCartDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 438, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 439, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 440, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 441, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 442, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 443, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 444, + "name": "shipping_address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 445, + "name": "billing_address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 446, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 399, + "name": "UpdateAddressDTO", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 413, + "name": "CreateAddressDTO", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 447, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 399, + "name": "UpdateAddressDTO", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 413, + "name": "CreateAddressDTO", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 448, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 438, + 439, + 440, + 441, + 442, + 443, + 444, + 445, + 446, + 447, + 448 + ] + } + ] + }, + { + "id": 449, + "name": "CreateLineItemTaxLineDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 450, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 451, + "name": "tax_rate_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 452, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 453, + "name": "rate", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 454, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 450, + 451, + 452, + 453, + 454 + ] + } + ] + }, + { + "id": 455, + "name": "CreateLineItemAdjustmentDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 456, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 457, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 458, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 459, + "name": "promotion_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 460, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 456, + 457, + 458, + 459, + 460 + ] + } + ] + }, + { + "id": 461, + "name": "UpdateLineItemTaxLineDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 462, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 463, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 464, + "name": "tax_rate_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 465, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 466, + "name": "rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 467, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 462, + 463, + 464, + 465, + 466, + 467 + ] + } + ] + }, + { + "id": 468, + "name": "UpdateLineItemAdjustmentDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 469, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 470, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 471, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 472, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 473, + "name": "promotion_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 474, + "name": "provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 469, + 470, + 471, + 472, + 473, + 474 + ] + } + ] + }, + { + "id": 475, + "name": "CreateLineItemDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 476, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 477, + "name": "subtitle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 478, + "name": "thumbnail", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 479, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 480, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 481, + "name": "product_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 482, + "name": "product_title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 483, + "name": "product_description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 484, + "name": "product_subtitle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 485, + "name": "product_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 486, + "name": "product_collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 487, + "name": "product_handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 488, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 489, + "name": "variant_sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 490, + "name": "variant_barcode", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 491, + "name": "variant_title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 492, + "name": "variant_option_values", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 493, + "name": "requires_shipping", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 494, + "name": "is_discountable", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 495, + "name": "is_tax_inclusive", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 496, + "name": "compare_at_unit_price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 497, + "name": "unit_price", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 498, + "name": "tax_lines", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 449, + "name": "CreateLineItemTaxLineDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 499, + "name": "adjustments", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 455, + "name": "CreateLineItemAdjustmentDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 476, + 477, + 478, + 479, + 480, + 481, + 482, + 483, + 484, + 485, + 486, + 487, + 488, + 489, + 490, + 491, + 492, + 493, + 494, + 495, + 496, + 497, + 498, + 499 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 500, + "name": "CreateLineItemForCartDTO" + } + ] + }, + { + "id": 500, + "name": "CreateLineItemForCartDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 502, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 476, + "name": "CreateLineItemDTO.title" + } + }, + { + "id": 503, + "name": "subtitle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 477, + "name": "CreateLineItemDTO.subtitle" + } + }, + { + "id": 504, + "name": "thumbnail", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 478, + "name": "CreateLineItemDTO.thumbnail" + } + }, + { + "id": 505, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "target": 480, + "name": "CreateLineItemDTO.quantity" + } + }, + { + "id": 506, + "name": "product_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 481, + "name": "CreateLineItemDTO.product_id" + } + }, + { + "id": 507, + "name": "product_title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 482, + "name": "CreateLineItemDTO.product_title" + } + }, + { + "id": 508, + "name": "product_description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 483, + "name": "CreateLineItemDTO.product_description" + } + }, + { + "id": 509, + "name": "product_subtitle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 484, + "name": "CreateLineItemDTO.product_subtitle" + } + }, + { + "id": 510, + "name": "product_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 485, + "name": "CreateLineItemDTO.product_type" + } + }, + { + "id": 511, + "name": "product_collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 486, + "name": "CreateLineItemDTO.product_collection" + } + }, + { + "id": 512, + "name": "product_handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 487, + "name": "CreateLineItemDTO.product_handle" + } + }, + { + "id": 513, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 488, + "name": "CreateLineItemDTO.variant_id" + } + }, + { + "id": 514, + "name": "variant_sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 489, + "name": "CreateLineItemDTO.variant_sku" + } + }, + { + "id": 515, + "name": "variant_barcode", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 490, + "name": "CreateLineItemDTO.variant_barcode" + } + }, + { + "id": 516, + "name": "variant_title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 491, + "name": "CreateLineItemDTO.variant_title" + } + }, + { + "id": 517, + "name": "variant_option_values", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 492, + "name": "CreateLineItemDTO.variant_option_values" + } + }, + { + "id": 518, + "name": "requires_shipping", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 493, + "name": "CreateLineItemDTO.requires_shipping" + } + }, + { + "id": 519, + "name": "is_discountable", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 494, + "name": "CreateLineItemDTO.is_discountable" + } + }, + { + "id": 520, + "name": "is_tax_inclusive", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": 495, + "name": "CreateLineItemDTO.is_tax_inclusive" + } + }, + { + "id": 521, + "name": "compare_at_unit_price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "target": 496, + "name": "CreateLineItemDTO.compare_at_unit_price" + } + }, + { + "id": 522, + "name": "unit_price", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "target": 497, + "name": "CreateLineItemDTO.unit_price" + } + }, + { + "id": 523, + "name": "tax_lines", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 449, + "name": "CreateLineItemTaxLineDTO", + "package": "@medusajs/types" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 498, + "name": "CreateLineItemDTO.tax_lines" + } + }, + { + "id": 524, + "name": "adjustments", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 455, + "name": "CreateLineItemAdjustmentDTO", + "package": "@medusajs/types" + } + }, + "inheritedFrom": { + "type": "reference", + "target": 499, + "name": "CreateLineItemDTO.adjustments" + } + }, + { + "id": 501, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + }, + "overwrites": { + "type": "reference", + "target": 479, + "name": "CreateLineItemDTO.cart_id" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 502, + 503, + 504, + 505, + 506, + 507, + 508, + 509, + 510, + 511, + 512, + 513, + 514, + 515, + 516, + 517, + 518, + 519, + 520, + 521, + 522, + 523, + 524, + 501 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 475, + "name": "CreateLineItemDTO", + "package": "@medusajs/types" + } + ] + }, + { + "id": 525, + "name": "UpdateLineItemWithSelectorDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 526, + "name": "selector", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": 263, + "name": "CartLineItemDTO", + "package": "@medusajs/types" + } + ], + "name": "Partial", + "package": "typescript" + } + }, + { + "id": 527, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": 528, + "name": "UpdateLineItemDTO", + "package": "@medusajs/types" + } + ], + "name": "Partial", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 526, + 527 + ] + } + ] + }, + { + "id": 528, + "name": "UpdateLineItemDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 538, + "name": "subtitle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.subtitle" + } + }, + { + "id": 539, + "name": "thumbnail", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.thumbnail" + } + }, + { + "id": 535, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.cart_id" + } + }, + { + "id": 537, + "name": "product_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.product_id" + } + }, + { + "id": 540, + "name": "product_title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.product_title" + } + }, + { + "id": 541, + "name": "product_description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.product_description" + } + }, + { + "id": 542, + "name": "product_subtitle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.product_subtitle" + } + }, + { + "id": 543, + "name": "product_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.product_type" + } + }, + { + "id": 544, + "name": "product_collection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.product_collection" + } + }, + { + "id": 545, + "name": "product_handle", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.product_handle" + } + }, + { + "id": 536, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.variant_id" + } + }, + { + "id": 546, + "name": "variant_sku", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.variant_sku" + } + }, + { + "id": 547, + "name": "variant_barcode", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.variant_barcode" + } + }, + { + "id": 548, + "name": "variant_title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.variant_title" + } + }, + { + "id": 549, + "name": "variant_option_values", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.variant_option_values" + } + }, + { + "id": 550, + "name": "requires_shipping", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.requires_shipping" + } + }, + { + "id": 551, + "name": "is_discountable", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.is_discountable" + } + }, + { + "id": 552, + "name": "is_tax_inclusive", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.is_tax_inclusive" + } + }, + { + "id": 553, + "name": "compare_at_unit_price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "Omit.compare_at_unit_price" + } + }, + { + "id": 529, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 530, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 531, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 532, + "name": "unit_price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 533, + "name": "tax_lines", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 449, + "name": "CreateLineItemTaxLineDTO", + "package": "@medusajs/types" + } + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": 461, + "name": "UpdateLineItemTaxLineDTO", + "package": "@medusajs/types" + } + } + ] + } + }, + { + "id": 534, + "name": "adjustments", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 455, + "name": "CreateLineItemAdjustmentDTO", + "package": "@medusajs/types" + } + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": 468, + "name": "UpdateLineItemAdjustmentDTO", + "package": "@medusajs/types" + } + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 538, + 539, + 535, + 537, + 540, + 541, + 542, + 543, + 544, + 545, + 536, + 546, + 547, + 548, + 549, + 550, + 551, + 552, + 553, + 529, + 530, + 531, + 532, + 533, + 534 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": 475, + "name": "CreateLineItemDTO", + "package": "@medusajs/types" + }, + { + "type": "union", + "types": [ + { + "type": "literal", + "value": "tax_lines" + }, + { + "type": "literal", + "value": "adjustments" + }, + { + "type": "literal", + "value": "title" + }, + { + "type": "literal", + "value": "quantity" + }, + { + "type": "literal", + "value": "unit_price" + } + ] + } + ], + "name": "Omit", + "package": "typescript" + } + ] + }, + { + "id": 554, + "name": "ICartModuleService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 555, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 556, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 557, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 558, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 304, + "name": "CartDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 559, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 304, + "name": "CartDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 560, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 561, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 562, + "name": "filters", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 338, + "name": "FilterableCartProps", + "package": "@medusajs/types" + } + }, + { + "id": 563, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 304, + "name": "CartDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 564, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 304, + "name": "CartDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 565, + "name": "listAndCount", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 566, + "name": "listAndCount", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 567, + "name": "filters", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 338, + "name": "FilterableCartProps", + "package": "@medusajs/types" + } + }, + { + "id": 568, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 304, + "name": "CartDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 569, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "tuple", + "elements": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 304, + "name": "CartDTO", + "package": "@medusajs/types" + } + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 570, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 571, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 572, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 426, + "name": "CreateCartDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 573, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 304, + "name": "CartDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 574, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 575, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 426, + "name": "CreateCartDTO", + "package": "@medusajs/types" + } + }, + { + "id": 576, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 304, + "name": "CartDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 577, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 578, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 579, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 437, + "name": "UpdateCartDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 580, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 304, + "name": "CartDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 581, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 582, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 437, + "name": "UpdateCartDTO", + "package": "@medusajs/types" + } + }, + { + "id": 583, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 304, + "name": "CartDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 584, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 585, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 586, + "name": "cartIds", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 587, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 588, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 589, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 590, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 591, + "name": "listAddresses", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 592, + "name": "listAddresses", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 593, + "name": "filters", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 347, + "name": "FilterableAddressProps", + "package": "@medusajs/types" + } + }, + { + "id": 594, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 226, + "name": "CartAddressDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 595, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 226, + "name": "CartAddressDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 596, + "name": "createAddresses", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 597, + "name": "createAddresses", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 598, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 413, + "name": "CreateAddressDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 599, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 226, + "name": "CartAddressDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 600, + "name": "createAddresses", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 601, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 413, + "name": "CreateAddressDTO", + "package": "@medusajs/types" + } + }, + { + "id": 602, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 226, + "name": "CartAddressDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 603, + "name": "updateAddresses", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 604, + "name": "updateAddresses", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 605, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 399, + "name": "UpdateAddressDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 606, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 226, + "name": "CartAddressDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 607, + "name": "updateAddresses", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 608, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 399, + "name": "UpdateAddressDTO", + "package": "@medusajs/types" + } + }, + { + "id": 609, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 226, + "name": "CartAddressDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 610, + "name": "deleteAddresses", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 611, + "name": "deleteAddresses", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 612, + "name": "ids", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 613, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 614, + "name": "deleteAddresses", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 615, + "name": "ids", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 616, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 617, + "name": "addLineItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 618, + "name": "addLineItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 619, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 500, + "name": "CreateLineItemForCartDTO", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 263, + "name": "CartLineItemDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 620, + "name": "addLineItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 621, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 500, + "name": "CreateLineItemForCartDTO", + "package": "@medusajs/types" + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 263, + "name": "CartLineItemDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 622, + "name": "addLineItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 623, + "name": "cartId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 624, + "name": "items", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 475, + "name": "CreateLineItemDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 625, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 263, + "name": "CartLineItemDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 626, + "name": "updateLineItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 627, + "name": "updateLineItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 628, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 525, + "name": "UpdateLineItemWithSelectorDTO", + "package": "@medusajs/types" + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 263, + "name": "CartLineItemDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 629, + "name": "updateLineItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 630, + "name": "selector", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": 263, + "name": "CartLineItemDTO", + "package": "@medusajs/types" + } + ], + "name": "Partial", + "package": "typescript" + } + }, + { + "id": 631, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": 528, + "name": "UpdateLineItemDTO", + "package": "@medusajs/types" + } + ], + "name": "Partial", + "package": "typescript" + } + }, + { + "id": 632, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 263, + "name": "CartLineItemDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 633, + "name": "updateLineItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 634, + "name": "lineId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 635, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": 528, + "name": "UpdateLineItemDTO", + "package": "@medusajs/types" + } + ], + "name": "Partial", + "package": "typescript" + } + }, + { + "id": 636, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 263, + "name": "CartLineItemDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 637, + "name": "removeLineItems", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 638, + "name": "removeLineItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 639, + "name": "itemIds", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 640, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 641, + "name": "removeLineItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 642, + "name": "itemIds", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 643, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 644, + "name": "removeLineItems", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 645, + "name": "selector", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "reference", + "target": 263, + "name": "CartLineItemDTO", + "package": "@medusajs/types" + } + ], + "name": "Partial", + "package": "typescript" + } + }, + { + "id": 646, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 647, + "name": "__joinerConfig", + "variant": "declaration", + "kind": 2048, + "flags": { + "isOptional": true + }, + "signatures": [ + { + "id": 648, + "name": "__joinerConfig", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reference", + "target": 1219, + "name": "ModuleJoinerConfig", + "package": "@medusajs/types" + }, + "inheritedFrom": { + "type": "reference", + "target": 1293, + "name": "IModuleService.__joinerConfig" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 1292, + "name": "IModuleService.__joinerConfig" + } + }, + { + "id": 649, "name": "__hooks", "variant": "declaration", "kind": 1024, @@ -250,14 +12914,14 @@ "type": { "type": "reflection", "declaration": { - "id": 199, + "id": 650, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 200, + "id": 651, "name": "onApplicationStart", "variant": "declaration", "kind": 1024, @@ -267,14 +12931,14 @@ "type": { "type": "reflection", "declaration": { - "id": 201, + "id": 652, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 202, + "id": 653, "name": "__type", "variant": "signature", "kind": 4096, @@ -304,7 +12968,7 @@ { "title": "Properties", "children": [ - 200 + 651 ] } ] @@ -312,885 +12976,496 @@ }, "inheritedFrom": { "type": "reference", - "target": 846, + "target": 1294, "name": "IModuleService.__hooks" } - }, - { - "id": 196, - "name": "__joinerConfig", - "variant": "declaration", - "kind": 2048, - "flags": { - "isOptional": true - }, - "signatures": [ - { - "id": 197, - "name": "__joinerConfig", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": 771, - "name": "ModuleJoinerConfig", - "package": "@medusajs/types" - }, - "inheritedFrom": { - "type": "reference", - "target": 845, - "name": "IModuleService.__joinerConfig" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 844, - "name": "IModuleService.__joinerConfig" - } } ], "groups": [ { "title": "Properties", "children": [ - 198 + 649 ] }, { "title": "Methods", "children": [ - 196 + 555, + 560, + 565, + 570, + 577, + 584, + 591, + 596, + 603, + 610, + 617, + 626, + 637, + 647 ] } ], "extendedTypes": [ { "type": "reference", - "target": 843, + "target": 1291, "name": "IModuleService", "package": "@medusajs/types" } ] - }, - { - "id": 168, - "name": "CartDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 169, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 172, - "name": "billing_address_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 177, - "name": "completed_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 180, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 175, - "name": "customer_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 184, - "name": "discount_total", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 171, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 194, - "name": "gift_card_tax_total", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 193, - "name": "gift_card_total", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 170, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 179, - "name": "idempotency_key", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 186, - "name": "item_tax_total", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 181, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 178, - "name": "payment_authorized_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 176, - "name": "payment_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 185, - "name": "raw_discount_total", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 192, - "name": "refundable_amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 189, - "name": "refunded_total", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 174, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 182, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 173, - "name": "shipping_address_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 187, - "name": "shipping_tax_total", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 183, - "name": "shipping_total", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 191, - "name": "subtotal", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 188, - "name": "tax_total", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 190, - "name": "total", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 172, - 177, - 180, - 175, - 184, - 171, - 194, - 193, - 170, - 179, - 186, - 181, - 178, - 176, - 185, - 192, - 189, - 174, - 182, - 173, - 187, - 183, - 191, - 188, - 190 - ] - } - ] - } - } } ], "groups": [ { "title": "Interfaces", "children": [ - 195 + 168, + 177, + 187, + 197, + 206, + 216, + 226, + 242, + 263, + 304, + 338, + 347, + 351, + 386, + 399, + 413, + 426, + 437, + 449, + 455, + 461, + 468, + 475, + 500, + 525, + 528, + 554 ] }, { "title": "Type Aliases", "children": [ - 168 + 359 ] } ] }, { - "id": 203, + "id": 2276, + "name": "SessionOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options to pass to " + }, + { + "kind": "code", + "text": "`express-session`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "children": [ + { + "id": 2277, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the session ID cookie to set in the response (and read from in the request). The default value is " + }, + { + "kind": "code", + "text": "`connect.sid`" + }, + { + "kind": "text", + "text": ". \nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#name) for more details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2278, + "name": "resave", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the session should be saved back to the session store, even if the session was never modified during the request. The default value is " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ".\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#resave) for more details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 2279, + "name": "rolling", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the session identifier cookie should be force-set on every response. The default value is " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ".\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#rolling) for more details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 2280, + "name": "saveUninitialized", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether a session that is \"uninitialized\" is forced to be saved to the store. The default value is " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": ". \nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#saveUninitialized) for more details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 2281, + "name": "secret", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The secret to sign the session ID cookie. By default, the value of " + }, + { + "kind": "code", + "text": "`cookie_secret`" + }, + { + "kind": "text", + "text": " is used.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#secret) for details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2282, + "name": "ttl", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used when calculating the " + }, + { + "kind": "code", + "text": "`Expires`" + }, + { + "kind": "text", + "text": " " + }, + { + "kind": "code", + "text": "`Set-Cookie`" + }, + { + "kind": "text", + "text": " attribute of cookies. By default, its value is " + }, + { + "kind": "code", + "text": "`10 * 60 * 60 * 1000`" + }, + { + "kind": "text", + "text": ".\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#cookiemaxage) for details." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2277, + 2278, + 2279, + 2280, + 2281, + 2282 + ] + } + ] + }, + { + "id": 654, "name": "CommonTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 318, - "name": "AddressCreatePayload", + "id": 655, + "name": "WithRequiredProperty", "variant": "declaration", - "kind": 256, + "kind": 2097152, "flags": {}, - "children": [ - { - "id": 324, - "name": "address_1", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "comment": { + "summary": [ + { + "kind": "text", + "text": "Utility type used to remove some optional attributes (coming from K) from a type T" } + ] + }, + "typeParameters": [ + { + "id": 656, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} }, { - "id": 325, - "name": "address_2", - "variant": "declaration", - "kind": 1024, + "id": 657, + "name": "K", + "variant": "typeParam", + "kind": 131072, "flags": {}, "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 326, - "name": "city", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 323, - "name": "company", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 327, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 319, - "name": "first_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 320, - "name": "last_name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 322, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 321, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 329, - "name": "postal_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 328, - "name": "province", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 656, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } } } ], - "groups": [ - { - "title": "Properties", - "children": [ - 324, - 325, - 326, - 323, - 327, - 319, - 320, - 322, - 321, - 329, - 328 - ] - } - ] + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 656, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + { + "type": "mapped", + "parameter": "Property", + "parameterType": { + "type": "reference", + "target": 657, + "name": "K", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "templateType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "Property" + }, + "name": "Property", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 656, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + "optionalModifier": "-" + } + ] + } }, { - "id": 306, - "name": "AddressPayload", + "id": 658, + "name": "PartialPick", "variant": "declaration", - "kind": 256, + "kind": 2097152, "flags": {}, - "children": [ + "typeParameters": [ { - "id": 312, - "name": "address_1", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } + "id": 659, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} }, { - "id": 313, - "name": "address_2", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, + "id": 660, + "name": "K", + "variant": "typeParam", + "kind": 131072, + "flags": {}, "type": { - "type": "intrinsic", - "name": "string" + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 659, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } } + } + ], + "type": { + "type": "mapped", + "parameter": "P", + "parameterType": { + "type": "reference", + "target": 660, + "name": "K", + "package": "@medusajs/types", + "refersToTypeParameter": true }, - { - "id": 314, - "name": "city", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 311, - "name": "company", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 315, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 307, - "name": "first_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 308, - "name": "last_name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 310, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { + "templateType": { + "type": "indexedAccess", + "indexType": { "type": "reference", "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "P" }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" + "name": "P", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 659, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true } }, - { - "id": 309, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 317, - "name": "postal_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 316, - "name": "province", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 312, - 313, - 314, - 311, - 315, - 307, - 308, - 310, - 309, - 317, - 316 - ] - } - ] + "optionalModifier": "+" + } }, { - "id": 210, + "id": 661, "name": "BaseEntity", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 212, + "id": 662, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 663, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -1206,18 +13481,7 @@ } }, { - "id": 211, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 213, + "id": 664, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -1237,276 +13501,106 @@ { "title": "Properties", "children": [ - 212, - 211, - 213 + 662, + 663, + 664 ] } ], "extendedBy": [ { "type": "reference", - "target": 214, + "target": 665, "name": "SoftDeletableEntity" } ] }, { - "id": 252, - "name": "CustomFindOptions", + "id": 665, + "name": "SoftDeletableEntity", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 255, - "name": "order", + "id": 667, + "name": "id", "variant": "declaration", "kind": 1024, - "flags": { - "isOptional": true + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" }, + "inheritedFrom": { + "type": "reference", + "target": 662, + "name": "BaseEntity.id" + } + }, + { + "id": 668, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, "type": { "type": "reference", "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/OrderByCondition.d.ts", - "qualifiedName": "OrderByCondition" + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" }, - "name": "OrderByCondition", - "package": "typeorm" + "name": "Date", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": 663, + "name": "BaseEntity.created_at" } }, { - "id": 253, - "name": "select", + "id": 669, + "name": "updated_at", "variant": "declaration", "kind": 1024, - "flags": { - "isOptional": true + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" }, + "inheritedFrom": { + "type": "reference", + "target": 664, + "name": "BaseEntity.updated_at" + } + }, + { + "id": 666, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, "type": { "type": "union", "types": [ { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsSelect.d.ts", - "qualifiedName": "FindOptionsSelect" - }, - "typeArguments": [ - { - "type": "reference", - "target": 258, - "name": "TModel", - "package": "@medusajs/types", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsSelect", - "package": "typeorm" + "type": "literal", + "value": null }, { "type": "reference", "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsSelect.d.ts", - "qualifiedName": "FindOptionsSelectByString" + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" }, - "typeArguments": [ - { - "type": "reference", - "target": 258, - "name": "TModel", - "package": "@medusajs/types", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsSelectByString", - "package": "typeorm" - } - ] - } - }, - { - "id": 256, - "name": "skip", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 257, - "name": "take", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 254, - "name": "where", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", - "qualifiedName": "FindOptionsWhere" - }, - "typeArguments": [ - { - "type": "reference", - "target": 258, - "name": "TModel", - "package": "@medusajs/types", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsWhere", - "package": "typeorm" - }, - { - "type": "mapped", - "parameter": "P", - "parameterType": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - }, - "templateType": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "P" - }, - "name": "P", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 258, - "name": "TModel", - "package": "@medusajs/types", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - } - }, - "optionalModifier": "+" - } - ] - }, - { - "type": "intersection", - "types": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", - "qualifiedName": "FindOptionsWhere" - }, - "typeArguments": [ - { - "type": "reference", - "target": 258, - "name": "TModel", - "package": "@medusajs/types", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsWhere", - "package": "typeorm" - } - }, - { - "type": "mapped", - "parameter": "P", - "parameterType": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - }, - "templateType": { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "P" - }, - "name": "P", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 258, - "name": "TModel", - "package": "@medusajs/types", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - } - }, - "optionalModifier": "+" - } - ] + "name": "Date", + "package": "typescript" } ] } @@ -1516,144 +13610,164 @@ { "title": "Properties", "children": [ - 255, - 253, - 256, - 257, - 254 + 667, + 668, + 669, + 666 ] } ], + "extendedTypes": [ + { + "type": "reference", + "target": 661, + "name": "BaseEntity", + "package": "@medusajs/types" + } + ] + }, + { + "id": 670, + "name": "Writable", + "variant": "declaration", + "kind": 2097152, + "flags": {}, "typeParameters": [ { - "id": 258, - "name": "TModel", + "id": 671, + "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} - }, - { - "id": 259, - "name": "InKeys", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 258, - "name": "TModel", - "package": "@medusajs/types", - "qualifiedName": "CustomFindOptions.TModel", - "refersToTypeParameter": true - } - } - } - ] - }, - { - "id": 288, - "name": "DateComparisonOperator", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 290, - "name": "gt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 291, - "name": "gte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 289, - "name": "lt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 292, - "name": "lte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } } ], - "groups": [ - { - "title": "Properties", - "children": [ - 290, - 291, - 289, - 292 + "type": { + "type": "mapped", + "parameter": "key", + "parameterType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 671, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + "templateType": { + "type": "union", + "types": [ + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "key" + }, + "name": "key", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 671, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "key" + }, + "name": "key", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 671, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + ], + "name": "FindOperator", + "package": "typeorm" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "key" + }, + "name": "key", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 671, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + } + ], + "name": "FindOperator", + "package": "typeorm" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", + "qualifiedName": "FindOperator" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ], + "name": "FindOperator", + "package": "typeorm" + } ] - } - ] + }, + "readonlyModifier": "-" + } }, { - "id": 286, - "name": "EmptyQueryParams", - "variant": "declaration", - "kind": 256, - "flags": {} - }, - { - "id": 221, + "id": 672, "name": "FindConfig", "variant": "declaration", "kind": 256, @@ -1676,7 +13790,132 @@ }, "children": [ { - "id": 226, + "id": 673, + "name": "select", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of strings, each being attribute names of the entity to retrieve in the result." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 682, + "name": "Entity", + "package": "@medusajs/types", + "qualifiedName": "FindConfig.Entity", + "refersToTypeParameter": true + } + } + ] + } + } + }, + { + "id": 674, + "name": "skip", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A number indicating the number of records to skip before retrieving the results." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 675, + "name": "take", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A number indicating the number of records to return in the result." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 676, + "name": "relations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of strings, each being relation names of the entity to retrieve in the result." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 677, "name": "order", "variant": "declaration", "kind": 1024, @@ -1710,20 +13949,20 @@ "type": { "type": "reflection", "declaration": { - "id": 227, + "id": 678, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 228, + "id": 679, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 229, + "id": 680, "name": "K", "variant": "param", "kind": 32768, @@ -1752,132 +13991,7 @@ } }, { - "id": 225, - "name": "relations", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of strings, each being relation names of the entity to retrieve in the result." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 222, - "name": "select", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of strings, each being attribute names of the entity to retrieve in the result." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 231, - "name": "Entity", - "package": "@medusajs/types", - "qualifiedName": "FindConfig.Entity", - "refersToTypeParameter": true - } - } - ] - } - } - }, - { - "id": 223, - "name": "skip", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A number indicating the number of records to skip before retrieving the results." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 224, - "name": "take", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A number indicating the number of records to return in the result." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 230, + "id": 681, "name": "withDeleted", "variant": "declaration", "kind": 1024, @@ -1910,18 +14024,18 @@ { "title": "Properties", "children": [ - 226, - 225, - 222, - 223, - 224, - 230 + 673, + 674, + 675, + 676, + 677, + 681 ] } ], "typeParameters": [ { - "id": 231, + "id": 682, "name": "Entity", "variant": "typeParam", "kind": 131072, @@ -1930,799 +14044,14 @@ ] }, { - "id": 333, - "name": "FindPaginationParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 335, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 334, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 335, - 334 - ] - } - ] - }, - { - "id": 330, - "name": "FindParams", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 331, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 332, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 331, - 332 - ] - } - ] - }, - { - "id": 301, - "name": "NumericalComparisonOperator", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 303, - "name": "gt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 304, - "name": "gte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 302, - "name": "lt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 305, - "name": "lte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 303, - 304, - 302, - 305 - ] - } - ] - }, - { - "id": 287, - "name": "RepositoryTransformOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "extendedBy": [ - { - "type": "reference", - "target": 1645, - "name": "ProductCategoryTransformOptions" - } - ] - }, - { - "id": 214, - "name": "SoftDeletableEntity", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 217, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 212, - "name": "BaseEntity.created_at" - } - }, - { - "id": 215, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 216, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 211, - "name": "BaseEntity.id" - } - }, - { - "id": 218, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 213, - "name": "BaseEntity.updated_at" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 217, - 215, - 216, - 218 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 210, - "name": "BaseEntity", - "package": "@medusajs/types" - } - ] - }, - { - "id": 293, - "name": "StringComparisonOperator", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 298, - "name": "contains", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 300, - "name": "ends_with", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 295, - "name": "gt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 296, - "name": "gte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 294, - "name": "lt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 297, - "name": "lte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 299, - "name": "starts_with", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 298, - 300, - 295, - 296, - 294, - 297, - 299 - ] - } - ] - }, - { - "id": 363, - "name": "ConfigModule", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 364, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 366, - "name": "featureFlags", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 367, - "name": "modules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Partial" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "reference", - "target": 698, - "name": "InternalModuleDeclaration", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 708, - "name": "ExternalModuleDeclaration", - "package": "@medusajs/types" - } - ] - } - ], - "name": "Partial", - "package": "typescript" - } - ] - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 368, - "name": "plugins", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reflection", - "declaration": { - "id": 369, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 371, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 370, - "name": "resolve", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 371, - 370 - ] - } - ] - } - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - }, - { - "id": 365, - "name": "projectConfig", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 342, - "name": "ProjectConfigOptions", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 366, - 367, - 368, - 365 - ] - } - ] - } - } - }, - { - "id": 383, - "name": "ContainerLike", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 384, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 385, - "name": "resolve", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 386, - "name": "resolve", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 387, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 388, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 387, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [ - 385 - ] - } - ] - } - } - }, - { - "id": 281, - "name": "DeleteResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The fields returned in the response of a DELETE request." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 282, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 285, - "name": "deleted", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the item was deleted successfully." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 283, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the item that was deleted." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 284, - "name": "object", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the item that was deleted." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 285, - 283, - 284 - ] - } - ] - } - } - }, - { - "id": 232, + "id": 683, "name": "ExtendedFindConfig", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 240, + "id": 691, "name": "TEntity", "variant": "typeParam", "kind": 131072, @@ -2751,7 +14080,7 @@ "typeArguments": [ { "type": "reference", - "target": 240, + "target": 691, "name": "TEntity", "package": "@medusajs/types", "refersToTypeParameter": true @@ -2797,7 +14126,7 @@ "typeArguments": [ { "type": "reference", - "target": 240, + "target": 691, "name": "TEntity", "package": "@medusajs/types", "refersToTypeParameter": true @@ -2832,68 +14161,14 @@ { "type": "reflection", "declaration": { - "id": 233, + "id": 684, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 237, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsOrder.d.ts", - "qualifiedName": "FindOptionsOrder" - }, - "typeArguments": [ - { - "type": "reference", - "target": 240, - "name": "TEntity", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsOrder", - "package": "typeorm" - } - }, - { - "id": 235, - "name": "relations", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsRelations.d.ts", - "qualifiedName": "FindOptionsRelations" - }, - "typeArguments": [ - { - "type": "reference", - "target": 240, - "name": "TEntity", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "FindOptionsRelations", - "package": "typeorm" - } - }, - { - "id": 234, + "id": 685, "name": "select", "variant": "declaration", "kind": 1024, @@ -2909,7 +14184,7 @@ "typeArguments": [ { "type": "reference", - "target": 240, + "target": 691, "name": "TEntity", "package": "@medusajs/types", "refersToTypeParameter": true @@ -2920,33 +14195,34 @@ } }, { - "id": 238, - "name": "skip", + "id": 686, + "name": "relations", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { - "type": "intrinsic", - "name": "number" + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsRelations.d.ts", + "qualifiedName": "FindOptionsRelations" + }, + "typeArguments": [ + { + "type": "reference", + "target": 691, + "name": "TEntity", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "FindOptionsRelations", + "package": "typeorm" } }, { - "id": 239, - "name": "take", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 236, + "id": 687, "name": "where", "variant": "declaration", "kind": 1024, @@ -2963,7 +14239,7 @@ "typeArguments": [ { "type": "reference", - "target": 240, + "target": 691, "name": "TEntity", "package": "@medusajs/types", "refersToTypeParameter": true @@ -2983,7 +14259,7 @@ "typeArguments": [ { "type": "reference", - "target": 240, + "target": 691, "name": "TEntity", "package": "@medusajs/types", "refersToTypeParameter": true @@ -2995,875 +14271,88 @@ } ] } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 237, - 235, - 234, - 238, - 239, - 236 - ] - } - ] - } - } - ] - } - }, - { - "id": 336, - "name": "HttpCompressionOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 337, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 338, - "name": "enabled", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 339, - "name": "level", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 340, - "name": "memLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 341, - "name": "threshold", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 338, - 339, - 340, - 341 - ] - } - ] - } - } - }, - { - "id": 372, - "name": "MedusaContainer", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/awilix/lib/container.d.ts", - "qualifiedName": "AwilixContainer" - }, - "name": "AwilixContainer", - "package": "awilix" - }, - { - "type": "reflection", - "declaration": { - "id": 373, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 380, - "name": "createScope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 381, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 382, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": 372, - "name": "MedusaContainer", - "package": "@medusajs/types" - } - } - ] - } - } }, { - "id": 374, - "name": "registerAdd", + "id": 688, + "name": "order", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "type": { - "type": "reflection", - "declaration": { - "id": 375, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 376, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 379, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "parameters": [ - { - "id": 377, - "name": "name", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 378, - "name": "registration", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 379, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": 372, - "name": "MedusaContainer", - "package": "@medusajs/types" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 380, - 374 - ] - } - ] - } - } - ] - } - }, - { - "id": 276, - "name": "PaginatedResponse", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 277, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 280, - "name": "count", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 278, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 279, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 280, - 278, - 279 - ] - } - ] - } - } - }, - { - "id": 207, - "name": "PartialPick", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 208, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - }, - { - "id": 209, - "name": "K", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 208, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - } - ], - "type": { - "type": "mapped", - "parameter": "P", - "parameterType": { - "type": "reference", - "target": 209, - "name": "K", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "P" - }, - "name": "P", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 208, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - }, - "optionalModifier": "+" - } - }, - { - "id": 342, - "name": "ProjectConfigOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 343, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 362, - "name": "admin_cors", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 349, - "name": "cookie_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 351, - "name": "database_database", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 356, - "name": "database_extra", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intersection", - "types": [ - { "type": "reference", "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsOrder.d.ts", + "qualifiedName": "FindOptionsOrder" }, "typeArguments": [ { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - }, - { - "type": "reflection", - "declaration": { - "id": 357, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 358, - "name": "ssl", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 359, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 360, - "name": "rejectUnauthorized", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "literal", - "value": false - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 360 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 358 - ] - } - ] - } - } - ] - } - }, - { - "id": 353, - "name": "database_logging", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/logger/LoggerOptions.d.ts", - "qualifiedName": "LoggerOptions" - }, - "name": "LoggerOptions", - "package": "typeorm" - } - }, - { - "id": 352, - "name": "database_schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 354, - "name": "database_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 350, - "name": "database_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 355, - "name": "http_compression", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 336, - "name": "HttpCompressionOptions", - "package": "@medusajs/types" - } - }, - { - "id": 348, - "name": "jwt_secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 346, - "name": "redis_options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/ioredis/built/redis/RedisOptions.d.ts", - "qualifiedName": "RedisOptions" - }, - "name": "RedisOptions", - "package": "ioredis" - } - }, - { - "id": 345, - "name": "redis_prefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 344, - "name": "redis_url", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 347, - "name": "session_options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1657, - "name": "SessionOptions", - "package": "@medusajs/types" - } - }, - { - "id": 361, - "name": "store_cors", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 362, - 349, - 351, - 356, - 353, - 352, - 354, - 350, - 355, - 348, - 346, - 345, - 344, - 347, - 361 - ] - } - ] - } - } - }, - { - "id": 260, - "name": "QueryConfig", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 268, - "name": "TEntity", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "reference", - "target": 210, - "name": "BaseEntity", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 261, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 264, - "name": "allowedFields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 265, - "name": "allowedRelations", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 262, - "name": "defaultFields", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "typeOperator", - "operator": "keyof", - "target": { "type": "reference", - "target": 268, + "target": 691, "name": "TEntity", "package": "@medusajs/types", "refersToTypeParameter": true } - }, - { - "type": "intrinsic", - "name": "string" - } + ], + "name": "FindOptionsOrder", + "package": "typeorm" + } + }, + { + "id": 689, + "name": "skip", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 690, + "name": "take", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 685, + 686, + 687, + 688, + 689, + 690 ] } - } - }, - { - "id": 266, - "name": "defaultLimit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 263, - "name": "defaultRelations", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 267, - "name": "isList", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 264, - 265, - 262, - 266, - 263, - 267 ] } - ] - } + } + ] } }, { - "id": 241, + "id": 692, "name": "QuerySelector", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 244, + "id": 695, "name": "TEntity", "variant": "typeParam", "kind": 131072, @@ -3875,11 +14364,11 @@ "types": [ { "type": "reference", - "target": 249, + "target": 700, "typeArguments": [ { "type": "reference", - "target": 244, + "target": 695, "name": "TEntity", "package": "@medusajs/types", "refersToTypeParameter": true @@ -3891,14 +14380,14 @@ { "type": "reflection", "declaration": { - "id": 242, + "id": 693, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 243, + "id": 694, "name": "q", "variant": "declaration", "kind": 1024, @@ -3915,7 +14404,7 @@ { "title": "Properties", "children": [ - 243 + 694 ] } ] @@ -3925,110 +14414,83 @@ } }, { - "id": 269, - "name": "RequestQueryFields", + "id": 696, + "name": "TreeQuerySelector", "variant": "declaration", "kind": 2097152, "flags": {}, + "typeParameters": [ + { + "id": 699, + "name": "TEntity", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], "type": { - "type": "reflection", - "declaration": { - "id": 270, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 271, - "name": "expand", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 692, + "typeArguments": [ + { + "type": "reference", + "target": 699, + "name": "TEntity", + "package": "@medusajs/types", + "refersToTypeParameter": true } - }, - { - "id": 272, - "name": "fields", + ], + "name": "QuerySelector", + "package": "@medusajs/types" + }, + { + "type": "reflection", + "declaration": { + "id": 697, + "name": "__type", "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 274, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 273, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 275, - "name": "order", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", + "kind": 65536, + "flags": {}, "children": [ - 271, - 272, - 274, - 273, - 275 + { + "id": 698, + "name": "include_descendants_tree", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 698 + ] + } ] } - ] - } + } + ] } }, { - "id": 249, + "id": 700, "name": "Selector", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 250, + "id": 701, "name": "TEntity", "variant": "typeParam", "kind": 131072, @@ -4043,7 +14505,7 @@ "operator": "keyof", "target": { "type": "reference", - "target": 250, + "target": 701, "name": "TEntity", "package": "@medusajs/types", "refersToTypeParameter": true @@ -4066,7 +14528,7 @@ }, "objectType": { "type": "reference", - "target": 250, + "target": 701, "name": "TEntity", "package": "@medusajs/types", "refersToTypeParameter": true @@ -4088,7 +14550,7 @@ }, "objectType": { "type": "reference", - "target": 250, + "target": 701, "name": "TEntity", "package": "@medusajs/types", "refersToTypeParameter": true @@ -4097,19 +14559,19 @@ }, { "type": "reference", - "target": 288, + "target": 739, "name": "DateComparisonOperator", "package": "@medusajs/types" }, { "type": "reference", - "target": 293, + "target": 744, "name": "StringComparisonOperator", "package": "@medusajs/types" }, { "type": "reference", - "target": 301, + "target": 752, "name": "NumericalComparisonOperator", "package": "@medusajs/types" }, @@ -4139,7 +14601,7 @@ }, "objectType": { "type": "reference", - "target": 250, + "target": 701, "name": "TEntity", "package": "@medusajs/types", "refersToTypeParameter": true @@ -4169,7 +14631,7 @@ } }, { - "id": 251, + "id": 702, "name": "TotalField", "variant": "declaration", "kind": 2097152, @@ -4217,99 +14679,289 @@ } }, { - "id": 245, - "name": "TreeQuerySelector", + "id": 703, + "name": "CustomFindOptions", "variant": "declaration", - "kind": 2097152, + "kind": 256, "flags": {}, - "typeParameters": [ + "children": [ { - "id": 248, - "name": "TEntity", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 241, - "typeArguments": [ + "id": 704, + "name": "select", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ { "type": "reference", - "target": 248, - "name": "TEntity", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "QuerySelector", - "package": "@medusajs/types" - }, - { - "type": "reflection", - "declaration": { - "id": 246, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 247, - "name": "include_descendants_tree", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsSelect.d.ts", + "qualifiedName": "FindOptionsSelect" + }, + "typeArguments": [ + { + "type": "reference", + "target": 709, + "name": "TModel", + "package": "@medusajs/types", + "qualifiedName": "CustomFindOptions.TModel", + "refersToTypeParameter": true } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 247 - ] - } - ] - } + ], + "name": "FindOptionsSelect", + "package": "typeorm" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsSelect.d.ts", + "qualifiedName": "FindOptionsSelectByString" + }, + "typeArguments": [ + { + "type": "reference", + "target": 709, + "name": "TModel", + "package": "@medusajs/types", + "qualifiedName": "CustomFindOptions.TModel", + "refersToTypeParameter": true + } + ], + "name": "FindOptionsSelectByString", + "package": "typeorm" + } + ] } - ] - } - }, - { - "id": 204, - "name": "WithRequiredProperty", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Utility type used to remove some optional attributes (coming from K) from a type T" + }, + { + "id": 705, + "name": "where", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "typeArguments": [ + { + "type": "reference", + "target": 709, + "name": "TModel", + "package": "@medusajs/types", + "qualifiedName": "CustomFindOptions.TModel", + "refersToTypeParameter": true + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + }, + { + "type": "mapped", + "parameter": "P", + "parameterType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "intrinsic", + "name": "symbol" + } + ] + }, + "templateType": { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "P" + }, + "name": "P", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 709, + "name": "TModel", + "package": "@medusajs/types", + "qualifiedName": "CustomFindOptions.TModel", + "refersToTypeParameter": true + } + } + }, + "optionalModifier": "+" + } + ] + }, + { + "type": "intersection", + "types": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/FindOptionsWhere.d.ts", + "qualifiedName": "FindOptionsWhere" + }, + "typeArguments": [ + { + "type": "reference", + "target": 709, + "name": "TModel", + "package": "@medusajs/types", + "qualifiedName": "CustomFindOptions.TModel", + "refersToTypeParameter": true + } + ], + "name": "FindOptionsWhere", + "package": "typeorm" + } + }, + { + "type": "mapped", + "parameter": "P", + "parameterType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "intrinsic", + "name": "symbol" + } + ] + }, + "templateType": { + "type": "array", + "elementType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "P" + }, + "name": "P", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 709, + "name": "TModel", + "package": "@medusajs/types", + "qualifiedName": "CustomFindOptions.TModel", + "refersToTypeParameter": true + } + } + }, + "optionalModifier": "+" + } + ] + } + ] } - ] - }, + }, + { + "id": 706, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/find-options/OrderByCondition.d.ts", + "qualifiedName": "OrderByCondition" + }, + "name": "OrderByCondition", + "package": "typeorm" + } + }, + { + "id": 707, + "name": "skip", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 708, + "name": "take", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 704, + 705, + 706, + 707, + 708 + ] + } + ], "typeParameters": [ { - "id": 205, - "name": "T", + "id": 709, + "name": "TModel", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 206, - "name": "K", + "id": 710, + "name": "InKeys", "variant": "typeParam", "kind": 131072, "flags": {}, @@ -4318,260 +14970,452 @@ "operator": "keyof", "target": { "type": "reference", - "target": 205, - "name": "T", + "target": 709, + "name": "TModel", "package": "@medusajs/types", + "qualifiedName": "CustomFindOptions.TModel", "refersToTypeParameter": true } } } - ], - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 205, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - { - "type": "mapped", - "parameter": "Property", - "parameterType": { - "type": "reference", - "target": 206, - "name": "K", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "templateType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "Property" - }, - "name": "Property", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 205, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - }, - "optionalModifier": "-" - } - ] - } + ] }, { - "id": 219, - "name": "Writable", + "id": 711, + "name": "QueryConfig", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 220, - "name": "T", + "id": 719, + "name": "TEntity", "variant": "typeParam", "kind": 131072, - "flags": {} + "flags": {}, + "type": { + "type": "reference", + "target": 661, + "name": "BaseEntity", + "package": "@medusajs/types" + } } ], "type": { - "type": "mapped", - "parameter": "key", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 220, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "union", - "types": [ + "type": "reflection", + "declaration": { + "id": 712, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "key" - }, - "name": "key", - "package": "@medusajs/types", - "refersToTypeParameter": true + "id": 713, + "name": "defaultFields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, - "objectType": { - "type": "reference", - "target": 220, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 719, + "name": "TEntity", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } } }, { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", - "qualifiedName": "FindOperator" + "id": 714, + "name": "defaultRelations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, - "typeArguments": [ - { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "key" - }, - "name": "key", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 220, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" } - ], - "name": "FindOperator", - "package": "typeorm" + } }, { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", - "qualifiedName": "FindOperator" + "id": 715, + "name": "allowedFields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "key" - }, - "name": "key", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 220, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" } - ], - "name": "FindOperator", - "package": "typeorm" + } }, { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/find-options/FindOperator.d.ts", - "qualifiedName": "FindOperator" + "id": 716, + "name": "allowedRelations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" } - ], - "name": "FindOperator", - "package": "typeorm" + } + }, + { + "id": 717, + "name": "defaultLimit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 718, + "name": "isList", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 713, + 714, + 715, + 716, + 717, + 718 + ] } ] - }, - "readonlyModifier": "-" + } } - } - ], - "groups": [ + }, { - "title": "Interfaces", - "children": [ - 318, - 306, - 210, - 252, - 288, - 286, - 221, - 333, - 330, - 301, - 287, - 214, - 293 + "id": 720, + "name": "RequestQueryFields", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 721, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 722, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 723, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 724, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 725, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 726, + "name": "order", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 722, + 723, + 724, + 725, + 726 + ] + } + ] + } + } + }, + { + "id": 727, + "name": "PaginatedResponse", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 728, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 729, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 730, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 731, + "name": "count", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 729, + 730, + 731 + ] + } + ] + } + } + }, + { + "id": 732, + "name": "DeleteResponse", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The fields returned in the response of a DELETE request." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 733, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 734, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the item that was deleted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 735, + "name": "object", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the item that was deleted." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 736, + "name": "deleted", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the item was deleted successfully." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 734, + 735, + 736 + ] + } + ] + } + } + }, + { + "id": 737, + "name": "EmptyQueryParams", + "variant": "declaration", + "kind": 256, + "flags": {} + }, + { + "id": 738, + "name": "RepositoryTransformOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "extendedBy": [ + { + "type": "reference", + "target": 2242, + "name": "ProductCategoryTransformOptions" + } ] }, { - "title": "Type Aliases", - "children": [ - 363, - 383, - 281, - 232, - 336, - 372, - 276, - 207, - 342, - 260, - 241, - 269, - 249, - 251, - 245, - 204, - 219 - ] - } - ] - }, - { - "id": 389, - "name": "CustomerTypes", - "variant": "declaration", - "kind": 4, - "flags": {}, - "children": [ - { - "id": 390, - "name": "CustomerDTO", + "id": 739, + "name": "DateComparisonOperator", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 397, - "name": "billing_address", + "id": 740, + "name": "lt", "variant": "declaration", "kind": 1024, "flags": { @@ -4579,187 +15423,289 @@ }, "type": { "type": "reference", - "target": 1, - "name": "AddressDTO", - "package": "@medusajs/types" + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" } }, { - "id": 393, - "name": "billing_address_id", + "id": 741, + "name": "gt", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" } }, { - "id": 409, - "name": "created_at", + "id": 742, + "name": "gte", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" } }, { - "id": 408, - "name": "deleted_at", + "id": 743, + "name": "lte", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" } - }, + } + ], + "groups": [ { - "id": 392, - "name": "email", + "title": "Properties", + "children": [ + 740, + 741, + 742, + 743 + ] + } + ] + }, + { + "id": 744, + "name": "StringComparisonOperator", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 745, + "name": "lt", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 395, + "id": 746, + "name": "gt", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 747, + "name": "gte", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 748, + "name": "lte", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 749, + "name": "contains", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 750, + "name": "starts_with", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 751, + "name": "ends_with", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 745, + 746, + 747, + 748, + 749, + 750, + 751 + ] + } + ] + }, + { + "id": 752, + "name": "NumericalComparisonOperator", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 753, + "name": "lt", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 754, + "name": "gt", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 755, + "name": "gte", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 756, + "name": "lte", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 753, + 754, + 755, + 756 + ] + } + ] + }, + { + "id": 757, + "name": "AddressPayload", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 758, "name": "first_name", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 401, - "name": "groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 402, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 403, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 403 - ] - } - ] - } - } - } - }, - { - "id": 400, - "name": "has_account", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 391, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 396, + "id": 759, "name": "last_name", "variant": "declaration", "kind": 1024, @@ -4767,21 +15713,25 @@ "isOptional": true }, "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] + "type": "intrinsic", + "name": "string" } }, { - "id": 407, + "id": 760, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 761, "name": "metadata", "variant": "declaration", "kind": 1024, @@ -4809,49 +15759,2227 @@ } }, { - "id": 404, - "name": "orders", + "id": 762, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 763, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 764, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 765, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 766, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 767, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 768, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 758, + 759, + 760, + 761, + 762, + 763, + 764, + 765, + 766, + 767, + 768 + ] + } + ] + }, + { + "id": 769, + "name": "AddressCreatePayload", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 770, + "name": "first_name", "variant": "declaration", "kind": 1024, "flags": {}, "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 405, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 771, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 772, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 773, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 774, + "name": "company", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 775, + "name": "address_1", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 776, + "name": "address_2", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 777, + "name": "city", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 778, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 779, + "name": "province", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 780, + "name": "postal_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 770, + 771, + 772, + 773, + 774, + 775, + 776, + 777, + 778, + 779, + 780 + ] + } + ] + }, + { + "id": 781, + "name": "FindParams", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 782, + "name": "expand", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 783, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 782, + 783 + ] + } + ] + }, + { + "id": 784, + "name": "FindPaginationParams", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 785, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 786, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 785, + 786 + ] + } + ] + }, + { + "id": 787, + "name": "HttpCompressionOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP compression configurations." + } + ] + }, + "children": [ + { + "id": 788, + "name": "enabled", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether HTTP compression is enabled. By default, it's " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 789, + "name": "level", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The level of zlib compression to apply to responses. A higher level will result in better compression but will take longer to complete. \nA lower level will result in less compression but will be much faster. The default value is " + }, + { + "kind": "code", + "text": "`6`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 790, + "name": "memLevel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "How much memory should be allocated to the internal compression state. It's an integer in the range of 1 (minimum level) and 9 (maximum level). \nThe default value is " + }, + { + "kind": "code", + "text": "`8`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 791, + "name": "threshold", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum response body size that compression is applied on. Its value can be the number of bytes or any string accepted by the \n[bytes](https://www.npmjs.com/package/bytes) module. The default value is " + }, + { + "kind": "code", + "text": "`1024`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 788, + 789, + 790, + 791 + ] + } + ] + }, + { + "id": 792, + "name": "ProjectConfigOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Essential configurations related to the Medusa backend, such as database and CORS configurations." + } + ] + }, + "children": [ + { + "id": 793, + "name": "store_cors", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n" + }, + { + "kind": "code", + "text": "`store_cors`" + }, + { + "kind": "text", + "text": " is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins. \n\nEvery origin in that list must either be:\n\n1. A URL. For example, " + }, + { + "kind": "code", + "text": "`http://localhost:8000`" + }, + { + "kind": "text", + "text": ". The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, " + }, + { + "kind": "code", + "text": "`.example.com`" + }, + { + "kind": "text", + "text": ". The regex pattern that the backend tests for is " + }, + { + "kind": "code", + "text": "`^([/~@;%#'])(.*?)\\1([gimsuy]*)$`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ { - "id": 406, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ + "kind": "text", + "text": "Some example values of common use cases:\n\n" + }, { - "title": "Properties", - "children": [ - 406 - ] + "kind": "code", + "text": "```bash\n# Allow different ports locally starting with 800\nSTORE_CORS=/http://localhost:800\\d+$/\n\n# Allow any origin ending with vercel.app. For example, storefront.vercel.app\nSTORE_CORS=/vercel\\.app$/\n\n# Allow all HTTP requests\nSTORE_CORS=/http://.+/\n```" + }, + { + "kind": "text", + "text": "\n\nThen, set the configuration in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ":\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n store_cors: process.env.STORE_CORS,\n // ...\n },\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\nIf you’re adding the value directly within " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ", make sure to add an extra escaping " + }, + { + "kind": "code", + "text": "`/`" + }, + { + "kind": "text", + "text": " for every backslash in the pattern. For example:\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n store_cors: \"/vercel\\\\.app$/\",\n // ...\n },\n // ...\n}\n```" } ] } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 794, + "name": "admin_cors", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n" + }, + { + "kind": "code", + "text": "`admin_cors`" + }, + { + "kind": "text", + "text": " is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins. \n\nEvery origin in that list must either be:\n\n1. A URL. For example, " + }, + { + "kind": "code", + "text": "`http://localhost:7001`" + }, + { + "kind": "text", + "text": ". The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, " + }, + { + "kind": "code", + "text": "`.example.com`" + }, + { + "kind": "text", + "text": ". The regex pattern that the backend tests for is " + }, + { + "kind": "code", + "text": "`^([/~@;%#'])(.*?)\\1([gimsuy]*)$`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Some example values of common use cases:\n\n" + }, + { + "kind": "code", + "text": "```bash\n# Allow different ports locally starting with 700\nADMIN_CORS=/http://localhost:700\\d+$/\n\n# Allow any origin ending with vercel.app. For example, admin.vercel.app\nADMIN_CORS=/vercel\\.app$/\n\n# Allow all HTTP requests\nADMIN_CORS=/http://.+/\n```" + }, + { + "kind": "text", + "text": "\n\nThen, set the configuration in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ":\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n admin_cors: process.env.ADMIN_CORS,\n // ...\n },\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\nIf you’re adding the value directly within " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ", make sure to add an extra escaping " + }, + { + "kind": "code", + "text": "`/`" + }, + { + "kind": "text", + "text": " for every backslash in the pattern. For example:\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n admin_cors: \"/http:\\\\/\\\\/localhost:700\\\\d+$/\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 795, + "name": "cookie_secret", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A random string used to create cookie tokens. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is " + }, + { + "kind": "code", + "text": "`supersecret`" + }, + { + "kind": "text", + "text": " However, in production, if this configuration is not set, an error is thrown and \nthe backend crashes." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n cookie_secret: process.env.COOKIE_SECRET ||\n \"supersecret\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 796, + "name": "jwt_secret", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A random string used to create authentication tokens. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is " + }, + { + "kind": "code", + "text": "`supersecret`" + }, + { + "kind": "text", + "text": " However, in production, if this configuration is not set an error, an\nerror is thrown and the backend crashes." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n jwt_secret: process.env.JWT_SECRET ||\n \"supersecret\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 797, + "name": "database_database", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the database to connect to. If specified in " + }, + { + "kind": "code", + "text": "`database_url`" + }, + { + "kind": "text", + "text": ", then it’s not required to include it.\n\nMake sure to create the PostgreSQL database before using it. You can check how to create a database in \n[PostgreSQL's documentation](https://www.postgresql.org/docs/current/sql-createdatabase.html)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_database: process.env.DATABASE_DATABASE || \n \"medusa-store\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 798, + "name": "database_url", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The connection URL of the database. The format of the connection URL for PostgreSQL is:\n\n" + }, + { + "kind": "code", + "text": "```bash\npostgres://[user][:password]@[host][:port]/[dbname]\n```" + }, + { + "kind": "text", + "text": "\n\nWhere:\n\n- " + }, + { + "kind": "code", + "text": "`[user]`" + }, + { + "kind": "text", + "text": ": (required) your PostgreSQL username. If not specified, the system's username is used by default. The database user that you use must have create privileges. If you're using the " + }, + { + "kind": "code", + "text": "`postgres`" + }, + { + "kind": "text", + "text": " superuser, then it should have these privileges by default. Otherwise, make sure to grant your user create privileges. You can learn how to do that in [PostgreSQL's documentation](https://www.postgresql.org/docs/current/ddl-priv.html).\n- " + }, + { + "kind": "code", + "text": "`[:password]`" + }, + { + "kind": "text", + "text": ": an optional password for the user. When provided, make sure to put " + }, + { + "kind": "code", + "text": "`:`" + }, + { + "kind": "text", + "text": " before the password.\n- " + }, + { + "kind": "code", + "text": "`[host]`" + }, + { + "kind": "text", + "text": ": (required) your PostgreSQL host. When run locally, it should be " + }, + { + "kind": "code", + "text": "`localhost`" + }, + { + "kind": "text", + "text": ".\n- " + }, + { + "kind": "code", + "text": "`[:post]`" + }, + { + "kind": "text", + "text": ": an optional port that the PostgreSQL server is listening on. By default, it's " + }, + { + "kind": "code", + "text": "`5432`" + }, + { + "kind": "text", + "text": ". When provided, make sure to put " + }, + { + "kind": "code", + "text": "`:`" + }, + { + "kind": "text", + "text": " before the port.\n- " + }, + { + "kind": "code", + "text": "`[dbname]`" + }, + { + "kind": "text", + "text": ": (required) the name of the database.\n\nYou can learn more about the connection URL format in [PostgreSQL’s documentation](https://www.postgresql.org/docs/current/libpq-connect.html)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, set the following database URL in your environment variables:\n\n" + }, + { + "kind": "code", + "text": "```bash\nDATABASE_URL=postgres://postgres@localhost/medusa-store\n```" + }, + { + "kind": "text", + "text": "\n\nThen, use the value in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ":\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_url: process.env.DATABASE_URL,\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 799, + "name": "database_schema", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The database schema to connect to. This is not required to provide if you’re using the default schema, which is " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_schema: process.env.DATABASE_SCHEMA || \n \"custom\",\n // ...\n },\n // ...\n}\n```" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 800, + "name": "database_logging", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This configuration specifies what database messages to log. Its value can be one of the following:\n\n- (default) A boolean value that indicates whether any messages should be logged.\n- The string value " + }, + { + "kind": "code", + "text": "`all`" + }, + { + "kind": "text", + "text": " that indicates all types of messages should be logged.\n- An array of log-level strings to indicate which type of messages to show in the logs. The strings can be " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`schema`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`error`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`warn`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`info`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`log`" + }, + { + "kind": "text", + "text": ", or " + }, + { + "kind": "code", + "text": "`migration`" + }, + { + "kind": "text", + "text": ". Refer to [Typeorm’s documentation](https://typeorm.io/logging#logging-options) for more details on what each of these values means.\n\nIf this configuration isn't set, its default value is " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ", meaning no database messages are logged." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_logging: [\n \"query\", \"error\",\n ],\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/logger/LoggerOptions.d.ts", + "qualifiedName": "LoggerOptions" + }, + "name": "LoggerOptions", + "package": "typeorm" + } + }, + { + "id": 802, + "name": "database_extra", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object that includes additional configurations to pass to the database connection. You can pass any configuration. One defined configuration to pass is \n" + }, + { + "kind": "code", + "text": "`ssl`" + }, + { + "kind": "text", + "text": " which enables support for TLS/SSL connections.\n\nThis is useful for production databases, which can be supported by setting the " + }, + { + "kind": "code", + "text": "`rejectUnauthorized`" + }, + { + "kind": "text", + "text": " attribute of " + }, + { + "kind": "code", + "text": "`ssl`" + }, + { + "kind": "text", + "text": " object to " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ". \nDuring development, it’s recommended not to pass this option." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_extra: \n process.env.NODE_ENV !== \"development\"\n ? { ssl: { rejectUnauthorized: false } }\n : {},\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 803, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 804, + "name": "ssl", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure support for TLS/SSL connection" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 805, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 806, + "name": "rejectUnauthorized", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to fail connection if the server certificate is verified against the list of supplied CAs and the hostname and no match is found." + } + ] + }, + "type": { + "type": "literal", + "value": false + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 806 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 804 + ] + } + ] + } + } + ] + } + }, + { + "id": 807, + "name": "redis_url", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to specify the URL to connect to Redis. This is only used for scheduled jobs. If you omit this configuration, scheduled jobs won't work.\n\n:::note\n\nYou must first have Redis installed. You can refer to [Redis's installation guide](https://redis.io/docs/getting-started/installation/).\n\n:::\n\nThe Redis connection URL has the following format:\n\n" + }, + { + "kind": "code", + "text": "```bash\nredis[s]://[[username][:password]@][host][:port][/db-number]\n```" + }, + { + "kind": "text", + "text": "\n\nFor a local Redis installation, the connection URL should be " + }, + { + "kind": "code", + "text": "`redis://localhost:6379`" + }, + { + "kind": "text", + "text": " unless you’ve made any changes to the Redis configuration during installation." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n redis_url: process.env.REDIS_URL || \n \"redis://localhost:6379\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 808, + "name": "redis_prefix", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prefix set on all keys stored in Redis. The default value is " + }, + { + "kind": "code", + "text": "`sess:`" + }, + { + "kind": "text", + "text": ". \n\nIf this configuration option is provided, it is prepended to " + }, + { + "kind": "code", + "text": "`sess:`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n redis_prefix: process.env.REDIS_PREFIX || \n \"medusa:\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 809, + "name": "redis_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object of options to pass ioredis. You can refer to [ioredis’s RedisOptions documentation](https://redis.github.io/ioredis/index.html#RedisOptions) \nfor the list of available options." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n redis_options: {\n connectionName: process.env.REDIS_CONNECTION_NAME || \n \"medusa\",\n },\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/ioredis/built/redis/RedisOptions.d.ts", + "qualifiedName": "RedisOptions" + }, + "name": "RedisOptions", + "package": "ioredis" + } + }, + { + "id": 810, + "name": "session_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object of options to pass to [express-session](https://www.npmjs.com/package/express-session)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n session_options: {\n name: process.env.SESSION_NAME || \n \"custom\",\n },\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": 2276, + "name": "SessionOptions", + "package": "@medusajs/types" + } + }, + { + "id": 811, + "name": "http_compression", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there. \nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIts value is an object that has the following properties:\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header " + }, + { + "kind": "code", + "text": "`\"x-no-compression\": true`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n http_compression: {\n enabled: true,\n level: 6,\n memLevel: 8,\n threshold: 1024,\n },\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": 787, + "name": "HttpCompressionOptions", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 793, + 794, + 795, + 796, + 797, + 798, + 799, + 800, + 802, + 807, + 808, + 809, + 810, + 811 + ] + } + ] + }, + { + "id": 812, + "name": "ConfigModule", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The configurations for your Medusa backend are in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": " located in the root of your Medusa project. The configurations include database, modules, and plugin configurations, among other configurations.\n\n" + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": " exports an object having the following properties:\n\n- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "projectConfig", + "target": 813, + "tsLinkText": "projectConfig" + }, + { + "kind": "text", + "text": ": (required): An object that holds general configurations related to the Medusa backend, such as database or CORS configurations.\n- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "plugins", + "target": 814, + "tsLinkText": "plugins" + }, + { + "kind": "text", + "text": ": An array of plugin configurations that defines what plugins are installed and optionally specifies each of their configurations.\n- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "modules", + "target": 818, + "tsLinkText": "modules" + }, + { + "kind": "text", + "text": ": An object that defines what modules are installed and optionally specifies each of their configurations.\n- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "featureFlags", + "target": 819, + "tsLinkText": "featureFlags" + }, + { + "kind": "text", + "text": ": An object that enables or disables features guarded by a feature flag.\n\nFor example:\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig,\n plugins,\n modules,\n featureFlags,\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---\n\n## Environment Variables\n\nIt's highly recommended to store the values of configurations in environment variables, then reference them within " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ".\n\nDuring development, you can set your environment variables in the " + }, + { + "kind": "code", + "text": "`.env`" + }, + { + "kind": "text", + "text": " file at the root of your Medusa backend project. In production, \nsetting the environment variables depends on the hosting provider.\n\n---" + } + ] + }, + "children": [ + { + "id": 813, + "name": "projectConfig", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This property holds essential configurations related to the Medusa backend, such as database and CORS configurations." + } + ] + }, + "type": { + "type": "reference", + "target": 792, + "name": "ProjectConfigOptions", + "package": "@medusajs/types" + } + }, + { + "id": 814, + "name": "plugins", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "On your Medusa backend, you can use [Plugins](https://docs.medusajs.com/development/plugins/overview) to add custom features or integrate third-party services. \nFor example, installing a plugin to use Stripe as a payment processor.\n\nAside from installing the plugin with NPM, you need to pass the plugin you installed into the " + }, + { + "kind": "code", + "text": "`plugins`" + }, + { + "kind": "text", + "text": " array defined in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ".\n\nThe items in the array can either be:\n\n- A string, which is the name of the plugin to add. You can pass a plugin as a string if it doesn’t require any configurations.\n- An object having the following properties:\n - " + }, + { + "kind": "code", + "text": "`resolve`" + }, + { + "kind": "text", + "text": ": The name of the plugin.\n - " + }, + { + "kind": "code", + "text": "`options`" + }, + { + "kind": "text", + "text": ": An object that includes the plugin’s options. These options vary for each plugin, and you should refer to the plugin’s documentation for available options." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n plugins: [\n `medusa-my-plugin-1`,\n {\n resolve: `medusa-my-plugin`,\n options: {\n apiKey: process.env.MY_API_KEY || \n `test`,\n },\n },\n // ...\n ],\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 815, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 816, + "name": "resolve", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 817, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 816, + 817 + ] + } + ] + } + } + ] } } }, { - "id": 399, - "name": "phone", + "id": 818, + "name": "modules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "In Medusa, commerce and core logic are modularized to allow developers to extend or replace certain [modules](https://docs.medusajs.com/development/modules/overview) \nwith custom implementations.\n\nAside from installing the module with NPM, you must add it to the exported object in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ".\n\nThe keys of the " + }, + { + "kind": "code", + "text": "`modules`" + }, + { + "kind": "text", + "text": " configuration object refer to the type of module. Its value can be one of the following:\n\n1. A boolean value indicating whether the module type is enabled;\n2. Or a string value indicating the name of the module to be used for the module type. This can be used if the module does not require any options;\n3. Or an object having the following properties, but typically you would mainly use the " + }, + { + "kind": "code", + "text": "`resolve`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`options`" + }, + { + "kind": "text", + "text": " properties only:\n 1. " + }, + { + "kind": "code", + "text": "`resolve`" + }, + { + "kind": "text", + "text": ": a string indicating the name of the module.\n 2. " + }, + { + "kind": "code", + "text": "`options`" + }, + { + "kind": "text", + "text": ": an object indicating the options to pass to the module. These options vary for each module, and you should refer to the module’s documentation for details on them.\n 3. " + }, + { + "kind": "code", + "text": "`resources`" + }, + { + "kind": "text", + "text": ": a string indicating whether the module shares the dependency container with the Medusa core. Its value can either be " + }, + { + "kind": "code", + "text": "`shared`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`isolated`" + }, + { + "kind": "text", + "text": ". Refer to the [Modules documentation](https://docs.medusajs.com/development/modules/create#module-scope) for more details.\n 4. " + }, + { + "kind": "code", + "text": "`alias`" + }, + { + "kind": "text", + "text": ": a string indicating a unique alias to register the module under. Other modules can’t use the same alias.\n 5. " + }, + { + "kind": "code", + "text": "`main`" + }, + { + "kind": "text", + "text": ": a boolean value indicating whether this module is the main registered module. This is useful when an alias is used." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n modules: {\n eventBus: {\n resolve: \"@medusajs/event-bus-local\",\n },\n cacheService: {\n resolve: \"@medusajs/cache-redis\",\n options: { \n redisUrl: process.env.CACHE_REDIS_URL,\n ttl: 30,\n },\n },\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1146, + "name": "InternalModuleDeclaration", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 1156, + "name": "ExternalModuleDeclaration", + "package": "@medusajs/types" + } + ] + } + ], + "name": "Partial", + "package": "typescript" + } + ] + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 819, + "name": "featureFlags", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Some features in the Medusa backend are guarded by a feature flag. This ensures constant shipping of new features while maintaining the engine’s stability.\n\nYou can specify whether a feature should or shouldn’t be used in your backend by enabling its feature flag. Feature flags can be enabled through either environment \nvariables or through this configuration exported in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ".\n\nIf you want to use the environment variables method, learn more about it in the [Feature Flags documentation](https://docs.medusajs.com/development/feature-flags/toggle#method-one-using-environment-variables).\n\nThe " + }, + { + "kind": "code", + "text": "`featureFlags`" + }, + { + "kind": "text", + "text": " configuration is an object. Its properties are the names of the feature flags. Each property’s value is a boolean indicating whether the feature flag is enabled.\n\nYou can find available feature flags and their key name [here](https://github.com/medusajs/medusa/tree/master/packages/medusa/src/loaders/feature-flags)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n featureFlags: {\n product_categories: true,\n // ...\n },\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::note\n\nAfter enabling a feature flag, make sure to [run migrations](https://docs.medusajs.com/development/entities/migrations/overview#migrate-command) as it may require making changes to the database.\n\n:::" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 813, + 814, + 818, + 819 + ] + } + ] + }, + { + "id": 820, + "name": "MedusaContainer", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Medusa Container extends [Awilix](https://github.com/jeffijoe/awilix) to \nprovide dependency injection functionalities." + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/awilix/lib/container.d.ts", + "qualifiedName": "AwilixContainer" + }, + "name": "AwilixContainer", + "package": "awilix" + }, + { + "type": "reflection", + "declaration": { + "id": 821, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {} + } + } + ] + } + }, + { + "id": 831, + "name": "ContainerLike", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 832, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 833, + "name": "resolve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 834, + "name": "resolve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "typeParameter": [ + { + "id": 835, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "parameters": [ + { + "id": 836, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": 835, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 833 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Interfaces", + "children": [ + 661, + 665, + 672, + 703, + 737, + 738, + 739, + 744, + 752, + 757, + 769, + 781, + 784, + 787, + 792, + 812 + ] + }, + { + "title": "Type Aliases", + "children": [ + 655, + 658, + 670, + 683, + 692, + 696, + 700, + 702, + 711, + 720, + 727, + 732, + 820, + 831 + ] + } + ] + }, + { + "id": 837, + "name": "CustomerTypes", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 838, + "name": "CustomerDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 839, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 840, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 841, + "name": "billing_address_id", "variant": "declaration", "kind": 1024, "flags": { @@ -4872,22 +18000,7 @@ } }, { - "id": 398, - "name": "shipping_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1, - "name": "AddressDTO", - "package": "@medusajs/types" - } - }, - { - "id": 394, + "id": 842, "name": "shipping_address_id", "variant": "declaration", "kind": 1024, @@ -4909,7 +18022,280 @@ } }, { - "id": 410, + "id": 843, + "name": "first_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 844, + "name": "last_name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 845, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1, + "name": "AddressDTO", + "package": "@medusajs/types" + } + }, + { + "id": 846, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1, + "name": "AddressDTO", + "package": "@medusajs/types" + } + }, + { + "id": 847, + "name": "phone", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 848, + "name": "has_account", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 849, + "name": "groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 850, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 851, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 851 + ] + } + ] + } + } + } + }, + { + "id": 852, + "name": "orders", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 853, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 854, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 854 + ] + } + ] + } + } + } + }, + { + "id": 855, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 856, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 857, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 858, "name": "updated_at", "variant": "declaration", "kind": 1024, @@ -4940,22 +18326,22 @@ { "title": "Properties", "children": [ - 397, - 393, - 409, - 408, - 392, - 395, - 401, - 400, - 391, - 396, - 407, - 404, - 399, - 398, - 394, - 410 + 839, + 840, + 841, + 842, + 843, + 844, + 845, + 846, + 847, + 848, + 849, + 852, + 855, + 856, + 857, + 858 ] } ] @@ -4965,20 +18351,62 @@ { "title": "Interfaces", "children": [ - 390 + 838 ] } ] }, { - "id": 411, + "id": 859, "name": "DAL", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 418, + "id": 987, + "name": "EntityDateColumns", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "created_at" + }, + { + "type": "literal", + "value": "updated_at" + } + ] + } + }, + { + "id": 988, + "name": "SoftDeletableEntityDateColumns", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "deleted_at" + }, + { + "type": "reference", + "target": 987, + "name": "EntityDateColumns", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 866, "name": "BaseFilterable", "variant": "declaration", "kind": 256, @@ -4993,7 +18421,7 @@ }, "children": [ { - "id": 419, + "id": 867, "name": "$and", "variant": "declaration", "kind": 1024, @@ -5015,7 +18443,7 @@ "types": [ { "type": "reference", - "target": 421, + "target": 869, "name": "T", "package": "@medusajs/types", "qualifiedName": "BaseFilterable.T", @@ -5023,11 +18451,11 @@ }, { "type": "reference", - "target": 418, + "target": 866, "typeArguments": [ { "type": "reference", - "target": 421, + "target": 869, "name": "T", "package": "@medusajs/types", "qualifiedName": "BaseFilterable.T", @@ -5042,7 +18470,7 @@ } }, { - "id": 420, + "id": 868, "name": "$or", "variant": "declaration", "kind": 1024, @@ -5064,7 +18492,7 @@ "types": [ { "type": "reference", - "target": 421, + "target": 869, "name": "T", "package": "@medusajs/types", "qualifiedName": "BaseFilterable.T", @@ -5072,11 +18500,11 @@ }, { "type": "reference", - "target": 418, + "target": 866, "typeArguments": [ { "type": "reference", - "target": 421, + "target": 869, "name": "T", "package": "@medusajs/types", "qualifiedName": "BaseFilterable.T", @@ -5095,14 +18523,14 @@ { "title": "Properties", "children": [ - 419, - 420 + 867, + 868 ] } ], "typeParameters": [ { - "id": 421, + "id": 869, "name": "T", "variant": "typeParam", "kind": 131072, @@ -5122,90 +18550,206 @@ }, { "type": "reference", - "target": 880, + "target": 338, + "name": "FilterableCartProps" + }, + { + "type": "reference", + "target": 347, + "name": "FilterableAddressProps" + }, + { + "type": "reference", + "target": 351, + "name": "FilterableLineItemProps" + }, + { + "type": "reference", + "target": 1328, "name": "FilterableApplicationMethodProps" }, { "type": "reference", - "target": 906, + "target": 1344, + "name": "FilterableCampaignProps" + }, + { + "type": "reference", + "target": 1355, + "name": "FilterableCampaignBudgetProps" + }, + { + "type": "reference", + "target": 1425, "name": "FilterablePromotionProps" }, { "type": "reference", - "target": 925, + "target": 1449, "name": "FilterablePromotionRuleProps" }, { "type": "reference", - "target": 936, + "target": 1462, "name": "FilterablePromotionRuleValueProps" }, { "type": "reference", - "target": 1305, + "target": 1894, "name": "FilterableCurrencyProps" }, { "type": "reference", - "target": 1333, + "target": 1922, "name": "FilterableMoneyAmountProps" }, { "type": "reference", - "target": 1368, + "target": 1957, "name": "FilterablePriceRuleProps" }, { "type": "reference", - "target": 1445, + "target": 2034, "name": "FilterablePriceSetProps" }, { "type": "reference", - "target": 1472, + "target": 2061, "name": "FilterablePriceSetMoneyAmountProps" }, { "type": "reference", - "target": 1492, + "target": 2081, "name": "FilterablePriceSetMoneyAmountRulesProps" }, { "type": "reference", - "target": 1511, + "target": 2100, "name": "FilterablePriceSetRuleTypeProps" }, { "type": "reference", - "target": 1532, + "target": 2121, "name": "FilterableRuleTypeProps" }, { "type": "reference", - "target": 1586, + "target": 2175, "name": "FilterablePriceListProps" }, { "type": "reference", - "target": 1594, + "target": 2183, "name": "FilterablePriceListRuleProps" }, { "type": "reference", - "target": 1601, + "target": 2190, "name": "FilterablePriceListRuleValueProps" } ] }, { - "id": 422, + "id": 870, "name": "OptionsQuery", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 427, + "id": 871, + "name": "populate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 872, + "name": "orderBy", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2284, + "typeArguments": [ + { + "type": "reference", + "target": 878, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "OptionsQuery.T", + "refersToTypeParameter": true + } + ], + "name": "Order", + "package": "@medusajs/types" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": 2284, + "typeArguments": [ + { + "type": "reference", + "target": 878, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "OptionsQuery.T", + "refersToTypeParameter": true + } + ], + "name": "Order", + "package": "@medusajs/types" + } + } + ] + } + }, + { + "id": 873, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 874, + "name": "offset", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 875, "name": "fields", "variant": "declaration", "kind": 1024, @@ -5221,55 +18765,7 @@ } }, { - "id": 429, - "name": "filters", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "reference", - "target": 1690, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "reference", - "target": 1690, - "name": "Dictionary", - "package": "@medusajs/types" - } - ] - } - ], - "name": "Dictionary", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 428, + "id": 876, "name": "groupBy", "variant": "declaration", "kind": 1024, @@ -5294,34 +18790,8 @@ } }, { - "id": 425, - "name": "limit", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 426, - "name": "offset", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 424, - "name": "orderBy", + "id": 877, + "name": "filters", "variant": "declaration", "kind": 1024, "flags": { @@ -5331,84 +18801,67 @@ "type": "union", "types": [ { - "type": "reference", - "target": 1688, - "typeArguments": [ - { - "type": "reference", - "target": 430, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "OptionsQuery.T", - "refersToTypeParameter": true - } - ], - "name": "Order", - "package": "@medusajs/types" + "type": "intrinsic", + "name": "boolean" }, { "type": "array", "elementType": { - "type": "reference", - "target": 1688, - "typeArguments": [ - { - "type": "reference", - "target": 430, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "OptionsQuery.T", - "refersToTypeParameter": true - } - ], - "name": "Order", - "package": "@medusajs/types" + "type": "intrinsic", + "name": "string" } + }, + { + "type": "reference", + "target": 2286, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reference", + "target": 2286, + "name": "Dictionary", + "package": "@medusajs/types" + } + ] + } + ], + "name": "Dictionary", + "package": "@medusajs/types" } ] } - }, - { - "id": 423, - "name": "populate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } } ], "groups": [ { "title": "Properties", "children": [ - 427, - 429, - 428, - 425, - 426, - 424, - 423 + 871, + 872, + 873, + 874, + 875, + 876, + 877 ] } ], "typeParameters": [ { - "id": 430, + "id": 878, "name": "T", "variant": "typeParam", "kind": 131072, "flags": {} }, { - "id": 431, + "id": 879, "name": "P", "variant": "typeParam", "kind": 131072, @@ -5425,7 +18878,126 @@ ] }, { - "id": 437, + "id": 880, + "name": "FindOptions", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 884, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 881, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 882, + "name": "where", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 860, + "typeArguments": [ + { + "type": "reference", + "target": 884, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "FilterQuery", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 860, + "typeArguments": [ + { + "type": "reference", + "target": 884, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "FilterQuery", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 883, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 870, + "typeArguments": [ + { + "type": "reference", + "target": 884, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "OptionsQuery", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 882, + 883 + ] + } + ] + } + } + }, + { + "id": 885, "name": "RepositoryService", "variant": "declaration", "kind": 256, @@ -5440,321 +19012,21 @@ }, "children": [ { - "id": 446, - "name": "create", + "id": 914, + "name": "transaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 447, - "name": "create", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 448, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - }, - { - "id": 449, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 489, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "RepositoryService.T", - "refersToTypeParameter": true - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 454, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 455, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 456, - "name": "ids", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 457, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 438, - "name": "find", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 439, - "name": "find", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 440, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 432, - "typeArguments": [ - { - "type": "reference", - "target": 489, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "RepositoryService.T", - "refersToTypeParameter": true - } - ], - "name": "FindOptions", - "package": "@medusajs/types" - } - }, - { - "id": 441, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 489, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "RepositoryService.T", - "refersToTypeParameter": true - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 442, - "name": "findAndCount", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 443, - "name": "findAndCount", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 444, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 432, - "typeArguments": [ - { - "type": "reference", - "target": 489, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "RepositoryService.T", - "refersToTypeParameter": true - } - ], - "name": "FindOptions", - "package": "@medusajs/types" - } - }, - { - "id": 445, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "tuple", - "elements": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 489, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "RepositoryService.T", - "refersToTypeParameter": true - } - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 481, - "name": "getActiveManager", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 482, - "name": "getActiveManager", + "id": 915, + "name": "transaction", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 483, + "id": 916, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -5765,42 +19037,182 @@ } } ], + "parameters": [ + { + "id": 917, + "name": "task", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 918, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 919, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 920, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 916, + "name": "TManager", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 921, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 922, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 923, + "name": "isolationLevel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 924, + "name": "transaction", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 916, + "name": "TManager", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + { + "id": 925, + "name": "enableNestedTransactions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 923, + 924, + 925 + ] + } + ] + } + } + } + ], "type": { "type": "reference", - "target": 483, - "name": "TManager", - "package": "@medusajs/types", - "refersToTypeParameter": true + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" }, "inheritedFrom": { "type": "reference", - "target": 1712, - "name": "BaseRepositoryService.getActiveManager" + "target": 2293, + "name": "BaseRepositoryService.transaction" } } ], "inheritedFrom": { "type": "reference", - "target": 1711, - "name": "BaseRepositoryService.getActiveManager" + "target": 2292, + "name": "BaseRepositoryService.transaction" } }, { - "id": 478, + "id": 926, "name": "getFreshManager", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 479, + "id": 927, "name": "getFreshManager", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 480, + "id": 928, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -5813,136 +19225,86 @@ ], "type": { "type": "reference", - "target": 480, + "target": 928, "name": "TManager", "package": "@medusajs/types", "refersToTypeParameter": true }, "inheritedFrom": { "type": "reference", - "target": 1709, + "target": 2305, "name": "BaseRepositoryService.getFreshManager" } } ], "inheritedFrom": { "type": "reference", - "target": 1708, + "target": 2304, "name": "BaseRepositoryService.getFreshManager" } }, { - "id": 462, - "name": "restore", + "id": 929, + "name": "getActiveManager", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 463, - "name": "restore", + "id": 930, + "name": "getActiveManager", "variant": "signature", "kind": 4096, "flags": {}, - "parameters": [ + "typeParameter": [ { - "id": 464, - "name": "ids", - "variant": "param", - "kind": 32768, + "id": 931, + "name": "TManager", + "variant": "typeParam", + "kind": 131072, "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 465, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" + "default": { + "type": "intrinsic", + "name": "unknown" } } ], "type": { "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "tuple", - "elements": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 489, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "RepositoryService.T", - "refersToTypeParameter": true - } - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - ], - "name": "Promise", - "package": "typescript" + "target": 931, + "name": "TManager", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "inheritedFrom": { + "type": "reference", + "target": 2308, + "name": "BaseRepositoryService.getActiveManager" } } - ] + ], + "inheritedFrom": { + "type": "reference", + "target": 2307, + "name": "BaseRepositoryService.getActiveManager" + } }, { - "id": 484, + "id": 932, "name": "serialize", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 485, + "id": 933, "name": "serialize", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 486, + "id": 934, "name": "TOutput", "variant": "typeParam", "kind": 131072, @@ -5967,7 +19329,7 @@ ], "parameters": [ { - "id": 487, + "id": 935, "name": "data", "variant": "param", "kind": 32768, @@ -5978,7 +19340,7 @@ } }, { - "id": 488, + "id": 936, "name": "options", "variant": "param", "kind": 32768, @@ -6000,7 +19362,7 @@ "typeArguments": [ { "type": "reference", - "target": 486, + "target": 934, "name": "TOutput", "package": "@medusajs/types", "refersToTypeParameter": true @@ -6011,26 +19373,395 @@ }, "inheritedFrom": { "type": "reference", - "target": 1715, + "target": 2311, "name": "BaseRepositoryService.serialize" } } ], "inheritedFrom": { "type": "reference", - "target": 1714, + "target": 2310, "name": "BaseRepositoryService.serialize" } }, { - "id": 458, + "id": 886, + "name": "find", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 887, + "name": "find", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 888, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 880, + "typeArguments": [ + { + "type": "reference", + "target": 937, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "RepositoryService.T", + "refersToTypeParameter": true + } + ], + "name": "FindOptions", + "package": "@medusajs/types" + } + }, + { + "id": 889, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 937, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "RepositoryService.T", + "refersToTypeParameter": true + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 890, + "name": "findAndCount", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 891, + "name": "findAndCount", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 892, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 880, + "typeArguments": [ + { + "type": "reference", + "target": 937, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "RepositoryService.T", + "refersToTypeParameter": true + } + ], + "name": "FindOptions", + "package": "@medusajs/types" + } + }, + { + "id": 893, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "tuple", + "elements": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 937, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "RepositoryService.T", + "refersToTypeParameter": true + } + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 894, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 895, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 896, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + }, + { + "id": 897, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 937, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "RepositoryService.T", + "refersToTypeParameter": true + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 898, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 899, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 900, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + }, + { + "id": 901, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 937, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "RepositoryService.T", + "refersToTypeParameter": true + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 902, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 903, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 904, + "name": "ids", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 905, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 906, "name": "softDelete", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 459, + "id": 907, "name": "softDelete", "variant": "signature", "kind": 4096, @@ -6056,7 +19787,7 @@ }, "parameters": [ { - "id": 460, + "id": 908, "name": "ids", "variant": "param", "kind": 32768, @@ -6070,7 +19801,7 @@ } }, { - "id": 461, + "id": 909, "name": "context", "variant": "param", "kind": 32768, @@ -6079,7 +19810,7 @@ }, "type": { "type": "reference", - "target": 1650, + "target": 2247, "name": "Context", "package": "@medusajs/types" } @@ -6099,7 +19830,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 489, + "target": 937, "name": "T", "package": "@medusajs/types", "qualifiedName": "RepositoryService.T", @@ -6138,21 +19869,183 @@ ] }, { - "id": 466, + "id": 910, + "name": "restore", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 911, + "name": "restore", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 912, + "name": "ids", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 913, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "tuple", + "elements": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 937, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "RepositoryService.T", + "refersToTypeParameter": true + } + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 914, + 926, + 929, + 932, + 886, + 890, + 894, + 898, + 902, + 906, + 910 + ] + } + ], + "typeParameters": [ + { + "id": 937, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 2291, + "typeArguments": [ + { + "type": "reference", + "target": 937, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "RepositoryService.T", + "refersToTypeParameter": true + } + ], + "name": "BaseRepositoryService", + "package": "@medusajs/types" + } + ] + }, + { + "id": 938, + "name": "TreeRepositoryService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Data access layer (DAL) interface to implements for any repository service.\nThis layer helps to separate the business logic (service layer) from accessing the\nORM directly and allows to switch to another ORM without changing the business logic." + } + ] + }, + "children": [ + { + "id": 957, "name": "transaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 467, + "id": 958, "name": "transaction", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 468, + "id": 959, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -6165,7 +20058,7 @@ ], "parameters": [ { - "id": 469, + "id": 960, "name": "task", "variant": "param", "kind": 32768, @@ -6173,28 +20066,28 @@ "type": { "type": "reflection", "declaration": { - "id": 470, + "id": 961, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 471, + "id": 962, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 472, + "id": 963, "name": "transactionManager", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 468, + "target": 916, "name": "TManager", "package": "@medusajs/types", "refersToTypeParameter": true @@ -6222,7 +20115,7 @@ } }, { - "id": 473, + "id": 964, "name": "context", "variant": "param", "kind": 32768, @@ -6232,27 +20125,14 @@ "type": { "type": "reflection", "declaration": { - "id": 474, + "id": 965, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 477, - "name": "enableNestedTransactions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 475, + "id": 966, "name": "isolationLevel", "variant": "declaration", "kind": 1024, @@ -6265,7 +20145,7 @@ } }, { - "id": 476, + "id": 967, "name": "transaction", "variant": "declaration", "kind": 1024, @@ -6274,20 +20154,33 @@ }, "type": { "type": "reference", - "target": 468, + "target": 916, "name": "TManager", "package": "@medusajs/types", "refersToTypeParameter": true } + }, + { + "id": 968, + "name": "enableNestedTransactions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "children": [ - 477, - 475, - 476 + 966, + 967, + 968 ] } ] @@ -6312,665 +20205,33 @@ }, "inheritedFrom": { "type": "reference", - "target": 1697, + "target": 2293, "name": "BaseRepositoryService.transaction" } } ], "inheritedFrom": { "type": "reference", - "target": 1696, + "target": 2292, "name": "BaseRepositoryService.transaction" } }, { - "id": 450, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 451, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 452, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - }, - { - "id": 453, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 489, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "RepositoryService.T", - "refersToTypeParameter": true - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [ - 446, - 454, - 438, - 442, - 481, - 478, - 462, - 484, - 458, - 466, - 450 - ] - } - ], - "typeParameters": [ - { - "id": 489, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1695, - "typeArguments": [ - { - "type": "reference", - "target": 489, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "RepositoryService.T", - "refersToTypeParameter": true - } - ], - "name": "BaseRepositoryService", - "package": "@medusajs/types" - } - ] - }, - { - "id": 536, - "name": "RestoreReturn", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object that is used to specify an entity's related entities that should be restored when the main entity is restored." - } - ] - }, - "children": [ - { - "id": 537, - "name": "returnLinkableKeys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of strings, each being the ID attribute names of the entity's relations." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 538, - "name": "TReturnableLinkableKeys", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 537 - ] - } - ], - "typeParameters": [ - { - "id": 538, - "name": "TReturnableLinkableKeys", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 533, - "name": "SoftDeleteReturn", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted." - } - ] - }, - "children": [ - { - "id": 534, - "name": "returnLinkableKeys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of strings, each being the ID attribute names of the entity's relations." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 535, - "name": "TReturnableLinkableKeys", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 534 - ] - } - ], - "typeParameters": [ - { - "id": 535, - "name": "TReturnableLinkableKeys", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "id": 490, - "name": "TreeRepositoryService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data access layer (DAL) interface to implements for any repository service.\nThis layer helps to separate the business logic (service layer) from accessing the\nORM directly and allows to switch to another ORM without changing the business logic." - } - ] - }, - "children": [ - { - "id": 501, - "name": "create", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 502, - "name": "create", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 503, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 504, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 532, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "TreeRepositoryService.T", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 505, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 506, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 507, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 508, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 491, - "name": "find", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 492, - "name": "find", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 493, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 432, - "typeArguments": [ - { - "type": "reference", - "target": 532, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "TreeRepositoryService.T", - "refersToTypeParameter": true - } - ], - "name": "FindOptions", - "package": "@medusajs/types" - } - }, - { - "id": 494, - "name": "transformOptions", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 287, - "name": "RepositoryTransformOptions", - "package": "@medusajs/types" - } - }, - { - "id": 495, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 532, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "TreeRepositoryService.T", - "refersToTypeParameter": true - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 496, - "name": "findAndCount", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 497, - "name": "findAndCount", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 498, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 432, - "typeArguments": [ - { - "type": "reference", - "target": 532, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "TreeRepositoryService.T", - "refersToTypeParameter": true - } - ], - "name": "FindOptions", - "package": "@medusajs/types" - } - }, - { - "id": 499, - "name": "transformOptions", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 287, - "name": "RepositoryTransformOptions", - "package": "@medusajs/types" - } - }, - { - "id": 500, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "tuple", - "elements": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 532, - "name": "T", - "package": "@medusajs/types", - "qualifiedName": "TreeRepositoryService.T", - "refersToTypeParameter": true - } - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 524, - "name": "getActiveManager", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 525, - "name": "getActiveManager", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 526, - "name": "TManager", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 483, - "name": "TManager", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "inheritedFrom": { - "type": "reference", - "target": 1712, - "name": "BaseRepositoryService.getActiveManager" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 1711, - "name": "BaseRepositoryService.getActiveManager" - } - }, - { - "id": 521, + "id": 969, "name": "getFreshManager", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 522, + "id": 970, "name": "getFreshManager", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 523, + "id": 971, "name": "TManager", "variant": "typeParam", "kind": 131072, @@ -6983,40 +20244,86 @@ ], "type": { "type": "reference", - "target": 480, + "target": 928, "name": "TManager", "package": "@medusajs/types", "refersToTypeParameter": true }, "inheritedFrom": { "type": "reference", - "target": 1709, + "target": 2305, "name": "BaseRepositoryService.getFreshManager" } } ], "inheritedFrom": { "type": "reference", - "target": 1708, + "target": 2304, "name": "BaseRepositoryService.getFreshManager" } }, { - "id": 527, + "id": 972, + "name": "getActiveManager", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 973, + "name": "getActiveManager", + "variant": "signature", + "kind": 4096, + "flags": {}, + "typeParameter": [ + { + "id": 974, + "name": "TManager", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": 931, + "name": "TManager", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "inheritedFrom": { + "type": "reference", + "target": 2308, + "name": "BaseRepositoryService.getActiveManager" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 2307, + "name": "BaseRepositoryService.getActiveManager" + } + }, + { + "id": 975, "name": "serialize", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 528, + "id": 976, "name": "serialize", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 529, + "id": 977, "name": "TOutput", "variant": "typeParam", "kind": 131072, @@ -7041,7 +20348,7 @@ ], "parameters": [ { - "id": 530, + "id": 978, "name": "data", "variant": "param", "kind": 32768, @@ -7052,7 +20359,7 @@ } }, { - "id": 531, + "id": 979, "name": "options", "variant": "param", "kind": 32768, @@ -7074,7 +20381,7 @@ "typeArguments": [ { "type": "reference", - "target": 486, + "target": 934, "name": "TOutput", "package": "@medusajs/types", "refersToTypeParameter": true @@ -7085,103 +20392,73 @@ }, "inheritedFrom": { "type": "reference", - "target": 1715, + "target": 2311, "name": "BaseRepositoryService.serialize" } } ], "inheritedFrom": { "type": "reference", - "target": 1714, + "target": 2310, "name": "BaseRepositoryService.serialize" } }, { - "id": 509, - "name": "transaction", + "id": 939, + "name": "find", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 510, - "name": "transaction", + "id": 940, + "name": "find", "variant": "signature", "kind": 4096, "flags": {}, - "typeParameter": [ - { - "id": 511, - "name": "TManager", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], "parameters": [ { - "id": 512, - "name": "task", + "id": 941, + "name": "options", "variant": "param", "kind": 32768, - "flags": {}, + "flags": { + "isOptional": true + }, "type": { - "type": "reflection", - "declaration": { - "id": 513, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 514, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 515, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 468, - "name": "TManager", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } + "type": "reference", + "target": 880, + "typeArguments": [ + { + "type": "reference", + "target": 980, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "TreeRepositoryService.T", + "refersToTypeParameter": true + } + ], + "name": "FindOptions", + "package": "@medusajs/types" } }, { - "id": 516, + "id": 942, + "name": "transformOptions", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 738, + "name": "RepositoryTransformOptions", + "package": "@medusajs/types" + } + }, + { + "id": 943, "name": "context", "variant": "param", "kind": 32768, @@ -7189,69 +20466,244 @@ "isOptional": true }, "type": { - "type": "reflection", - "declaration": { - "id": 517, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 520, - "name": "enableNestedTransactions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 518, - "name": "isolationLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 519, - "name": "transaction", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 468, - "name": "TManager", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 520, - 518, - 519 - ] - } - ] + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 980, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "TreeRepositoryService.T", + "refersToTypeParameter": true } } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 944, + "name": "findAndCount", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 945, + "name": "findAndCount", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 946, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 880, + "typeArguments": [ + { + "type": "reference", + "target": 980, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "TreeRepositoryService.T", + "refersToTypeParameter": true + } + ], + "name": "FindOptions", + "package": "@medusajs/types" + } + }, + { + "id": 947, + "name": "transformOptions", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 738, + "name": "RepositoryTransformOptions", + "package": "@medusajs/types" + } + }, + { + "id": 948, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "tuple", + "elements": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 980, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "TreeRepositoryService.T", + "refersToTypeParameter": true + } + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 949, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 950, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 951, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 952, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 980, + "name": "T", + "package": "@medusajs/types", + "qualifiedName": "TreeRepositoryService.T", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 953, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 954, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 955, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 956, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } } ], "type": { @@ -7263,44 +20715,34 @@ "typeArguments": [ { "type": "intrinsic", - "name": "any" + "name": "void" } ], "name": "Promise", "package": "typescript" - }, - "inheritedFrom": { - "type": "reference", - "target": 1697, - "name": "BaseRepositoryService.transaction" } } - ], - "inheritedFrom": { - "type": "reference", - "target": 1696, - "name": "BaseRepositoryService.transaction" - } + ] } ], "groups": [ { "title": "Methods", "children": [ - 501, - 505, - 491, - 496, - 524, - 521, - 527, - 509 + 957, + 969, + 972, + 975, + 939, + 944, + 949, + 953 ] } ], "typeParameters": [ { - "id": 532, + "id": 980, "name": "T", "variant": "typeParam", "kind": 131072, @@ -7314,11 +20756,11 @@ "extendedTypes": [ { "type": "reference", - "target": 1695, + "target": 2291, "typeArguments": [ { "type": "reference", - "target": 532, + "target": 980, "name": "T", "package": "@medusajs/types", "qualifiedName": "TreeRepositoryService.T", @@ -7331,34 +20773,144 @@ ] }, { - "id": 539, - "name": "EntityDateColumns", + "id": 981, + "name": "SoftDeleteReturn", "variant": "declaration", - "kind": 2097152, + "kind": 256, "flags": {}, - "type": { - "type": "union", - "types": [ + "comment": { + "summary": [ { - "type": "literal", - "value": "created_at" - }, - { - "type": "literal", - "value": "updated_at" + "kind": "text", + "text": "An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted." } ] - } + }, + "children": [ + { + "id": 982, + "name": "returnLinkableKeys", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of strings, each being the ID attribute names of the entity's relations." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 983, + "name": "TReturnableLinkableKeys", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 982 + ] + } + ], + "typeParameters": [ + { + "id": 983, + "name": "TReturnableLinkableKeys", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "string" + } + } + ] }, { - "id": 412, + "id": 984, + "name": "RestoreReturn", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object that is used to specify an entity's related entities that should be restored when the main entity is restored." + } + ] + }, + "children": [ + { + "id": 985, + "name": "returnLinkableKeys", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of strings, each being the ID attribute names of the entity's relations." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 986, + "name": "TReturnableLinkableKeys", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 985 + ] + } + ], + "typeParameters": [ + { + "id": 986, + "name": "TReturnableLinkableKeys", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "id": 860, "name": "FilterQuery", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 416, + "id": 864, "name": "T", "variant": "typeParam", "kind": 131072, @@ -7369,7 +20921,7 @@ } }, { - "id": 417, + "id": 865, "name": "Prev", "variant": "typeParam", "kind": 131072, @@ -7388,7 +20940,7 @@ "type": "conditional", "checkType": { "type": "reference", - "target": 417, + "target": 865, "name": "Prev", "package": "@medusajs/types", "refersToTypeParameter": true @@ -7409,7 +20961,7 @@ "operator": "keyof", "target": { "type": "reference", - "target": 416, + "target": 864, "name": "T", "package": "@medusajs/types", "refersToTypeParameter": true @@ -7431,7 +20983,7 @@ }, "objectType": { "type": "reference", - "target": 416, + "target": 864, "name": "T", "package": "@medusajs/types", "refersToTypeParameter": true @@ -7488,7 +21040,7 @@ }, "objectType": { "type": "reference", - "target": 416, + "target": 864, "name": "T", "package": "@medusajs/types", "refersToTypeParameter": true @@ -7496,7 +21048,7 @@ }, { "type": "reference", - "target": 1665, + "target": 2254, "typeArguments": [ { "type": "indexedAccess", @@ -7512,7 +21064,7 @@ }, "objectType": { "type": "reference", - "target": 416, + "target": 864, "name": "T", "package": "@medusajs/types", "refersToTypeParameter": true @@ -7540,7 +21092,7 @@ }, "objectType": { "type": "reference", - "target": 416, + "target": 864, "name": "T", "package": "@medusajs/types", "refersToTypeParameter": true @@ -7565,20 +21117,20 @@ "extendsType": { "type": "reflection", "declaration": { - "id": 413, + "id": 861, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 414, + "id": 862, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 415, + "id": 863, "name": "x", "variant": "param", "kind": 32768, @@ -7614,7 +21166,7 @@ }, "trueType": { "type": "reference", - "target": 412, + "target": 860, "typeArguments": [ { "type": "reference", @@ -7641,14 +21193,14 @@ "type": "indexedAccess", "indexType": { "type": "reference", - "target": 417, + "target": 865, "name": "Prev", "package": "@medusajs/types", "refersToTypeParameter": true }, "objectType": { "type": "reference", - "target": 1687, + "target": 2283, "name": "PrevLimit", "package": "@medusajs/types" } @@ -7676,37 +21228,2163 @@ "optionalModifier": "+" } } + } + ], + "groups": [ + { + "title": "Interfaces", + "children": [ + 866, + 870, + 885, + 938, + 981, + 984 + ] }, { - "id": 432, - "name": "FindOptions", + "title": "Type Aliases", + "children": [ + 987, + 988, + 880, + 860 + ] + } + ] + }, + { + "id": 2291, + "name": "BaseRepositoryService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Data access layer (DAL) interface to implements for any repository service.\nThis layer helps to separate the business logic (service layer) from accessing the\nORM directly and allows to switch to another ORM without changing the business logic." + } + ] + }, + "children": [ + { + "id": 2292, + "name": "transaction", "variant": "declaration", - "kind": 2097152, + "kind": 2048, "flags": {}, - "typeParameters": [ + "signatures": [ { - "id": 436, - "name": "T", - "variant": "typeParam", - "kind": 131072, + "id": 2293, + "name": "transaction", + "variant": "signature", + "kind": 4096, "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" + "typeParameter": [ + { + "id": 2294, + "name": "TManager", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "parameters": [ + { + "id": 2295, + "name": "task", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 2296, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 2297, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 2298, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 916, + "name": "TManager", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 2299, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2300, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2301, + "name": "isolationLevel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2302, + "name": "transaction", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 916, + "name": "TManager", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + { + "id": 2303, + "name": "enableNestedTransactions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2301, + 2302, + 2303 + ] + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" } } + ] + }, + { + "id": 2304, + "name": "getFreshManager", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2305, + "name": "getFreshManager", + "variant": "signature", + "kind": 4096, + "flags": {}, + "typeParameter": [ + { + "id": 2306, + "name": "TManager", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": 928, + "name": "TManager", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + ] + }, + { + "id": 2307, + "name": "getActiveManager", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2308, + "name": "getActiveManager", + "variant": "signature", + "kind": 4096, + "flags": {}, + "typeParameter": [ + { + "id": 2309, + "name": "TManager", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": 931, + "name": "TManager", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + ] + }, + { + "id": 2310, + "name": "serialize", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2311, + "name": "serialize", + "variant": "signature", + "kind": 4096, + "flags": {}, + "typeParameter": [ + { + "id": 2312, + "name": "TOutput", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "object" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "object" + } + } + ] + } + } + ], + "parameters": [ + { + "id": 2313, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 2314, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 934, + "name": "TOutput", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 2292, + 2304, + 2307, + 2310 + ] + } + ], + "typeParameters": [ + { + "id": 2315, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 885, + "name": "RepositoryService" + }, + { + "type": "reference", + "target": 938, + "name": "TreeRepositoryService" + } + ] + }, + { + "id": 2286, + "name": "Dictionary", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 2290, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 2287, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "indexSignature": { + "id": 2288, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "parameters": [ + { + "id": 2289, + "name": "k", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": 2290, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + } + } + }, + { + "id": 2324, + "name": "Query", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 2325, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "conditional", + "checkType": { + "type": "reference", + "target": 2325, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "extendsType": { + "type": "intrinsic", + "name": "object" + }, + "trueType": { + "type": "conditional", + "checkType": { + "type": "reference", + "target": 2325, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "extendsType": { + "type": "reference", + "target": 2328, + "name": "Scalar", + "package": "@medusajs/types" + }, + "trueType": { + "type": "intrinsic", + "name": "never" + }, + "falseType": { + "type": "reference", + "target": 860, + "typeArguments": [ + { + "type": "reference", + "target": 2325, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "FilterQuery", + "package": "@medusajs/types" + } + }, + "falseType": { + "type": "reference", + "target": 2332, + "typeArguments": [ + { + "type": "reference", + "target": 2325, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } ], - "type": { + "name": "FilterValue", + "package": "@medusajs/types" + } + } + }, + { + "id": 2326, + "name": "ExpandScalar", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 2327, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "conditional", + "checkType": { + "type": "reference", + "target": 2327, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "extendsType": { + "type": "intrinsic", + "name": "string" + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "RegExp" + }, + "name": "RegExp", + "package": "typescript" + } + ] + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "target": 2327, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "extendsType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "falseType": { + "type": "reference", + "target": 2327, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + } + ] + } + }, + { + "id": 2328, + "name": "Scalar", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "intrinsic", + "name": "number" + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "bigint" + }, + { + "type": "intrinsic", + "name": "symbol" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "RegExp" + }, + "name": "RegExp", + "package": "typescript" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/@types/node/buffer.d.ts", + "qualifiedName": "__global.Buffer" + }, + "name": "Buffer", + "package": "@types/node", + "qualifiedName": "__global.Buffer" + }, + { "type": "reflection", "declaration": { - "id": 433, + "id": 2329, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 435, + "id": 2330, + "name": "toHexString", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 2331, + "name": "toHexString", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 2330 + ] + } + ] + } + } + ] + } + }, + { + "id": 2346, + "name": "ReadonlyPrimary", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 2347, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "conditional", + "checkType": { + "type": "reference", + "target": 2347, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + }, + "trueType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Readonly" + }, + "typeArguments": [ + { + "type": "reference", + "target": 2347, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "Readonly", + "package": "typescript" + }, + "falseType": { + "type": "reference", + "target": 2347, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + }, + { + "id": 2336, + "name": "Primary", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 2345, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "conditional", + "checkType": { + "type": "reference", + "target": 2345, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 2337, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2338, + "name": "[PrimaryKeyType]", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "inferred", + "name": "PK" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2338 + ] + } + ] + } + }, + "trueType": { + "type": "reference", + "target": 2346, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "PK" + }, + "name": "PK", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ReadonlyPrimary", + "package": "@medusajs/types" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "target": 2345, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 2339, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2340, + "name": "_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "inferred", + "name": "PK" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2340 + ] + } + ] + } + }, + "trueType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2346, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "PK" + }, + "name": "PK", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ReadonlyPrimary", + "package": "@medusajs/types" + }, + { + "type": "intrinsic", + "name": "string" + } + ] + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "target": 2345, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 2341, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2342, + "name": "uuid", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "inferred", + "name": "PK" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2342 + ] + } + ] + } + }, + "trueType": { + "type": "reference", + "target": 2346, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "PK" + }, + "name": "PK", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ReadonlyPrimary", + "package": "@medusajs/types" + }, + "falseType": { + "type": "conditional", + "checkType": { + "type": "reference", + "target": 2345, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "extendsType": { + "type": "reflection", + "declaration": { + "id": 2343, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2344, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "inferred", + "name": "PK" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2344 + ] + } + ] + } + }, + "trueType": { + "type": "reference", + "target": 2346, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "PK" + }, + "name": "PK", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ReadonlyPrimary", + "package": "@medusajs/types" + }, + "falseType": { + "type": "intrinsic", + "name": "never" + } + } + } + } + } + }, + { + "id": 2254, + "name": "OperatorMap", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 2275, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 2255, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2256, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2324, + "typeArguments": [ + { + "type": "reference", + "target": 2275, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "Query", + "package": "@medusajs/types" + } + } + }, + { + "id": 2257, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2324, + "typeArguments": [ + { + "type": "reference", + "target": 2275, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "Query", + "package": "@medusajs/types" + } + } + }, + { + "id": 2258, + "name": "$eq", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2326, + "typeArguments": [ + { + "type": "reference", + "target": 2275, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ExpandScalar", + "package": "@medusajs/types" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": 2326, + "typeArguments": [ + { + "type": "reference", + "target": 2275, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ExpandScalar", + "package": "@medusajs/types" + } + } + ] + } + }, + { + "id": 2259, + "name": "$ne", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2326, + "typeArguments": [ + { + "type": "reference", + "target": 2275, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ExpandScalar", + "package": "@medusajs/types" + } + }, + { + "id": 2260, + "name": "$in", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2326, + "typeArguments": [ + { + "type": "reference", + "target": 2275, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ExpandScalar", + "package": "@medusajs/types" + } + } + }, + { + "id": 2261, + "name": "$nin", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2326, + "typeArguments": [ + { + "type": "reference", + "target": 2275, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ExpandScalar", + "package": "@medusajs/types" + } + } + }, + { + "id": 2262, + "name": "$not", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2324, + "typeArguments": [ + { + "type": "reference", + "target": 2275, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "Query", + "package": "@medusajs/types" + } + }, + { + "id": 2263, + "name": "$gt", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2326, + "typeArguments": [ + { + "type": "reference", + "target": 2275, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ExpandScalar", + "package": "@medusajs/types" + } + }, + { + "id": 2264, + "name": "$gte", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2326, + "typeArguments": [ + { + "type": "reference", + "target": 2275, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ExpandScalar", + "package": "@medusajs/types" + } + }, + { + "id": 2265, + "name": "$lt", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2326, + "typeArguments": [ + { + "type": "reference", + "target": 2275, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ExpandScalar", + "package": "@medusajs/types" + } + }, + { + "id": 2266, + "name": "$lte", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2326, + "typeArguments": [ + { + "type": "reference", + "target": 2275, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ExpandScalar", + "package": "@medusajs/types" + } + }, + { + "id": 2267, + "name": "$like", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2268, + "name": "$re", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2269, + "name": "$ilike", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2270, + "name": "$fulltext", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2271, + "name": "$overlap", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2272, + "name": "$contains", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2273, + "name": "$contained", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2274, + "name": "$exists", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2256, + 2257, + 2258, + 2259, + 2260, + 2261, + 2262, + 2263, + 2264, + 2265, + 2266, + 2267, + 2268, + 2269, + 2270, + 2271, + 2272, + 2273, + 2274 + ] + } + ] + } + } + }, + { + "id": 2334, + "name": "FilterValue2", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 2335, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2335, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + { + "type": "reference", + "target": 2326, + "typeArguments": [ + { + "type": "reference", + "target": 2335, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "ExpandScalar", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 2336, + "typeArguments": [ + { + "type": "reference", + "target": 2335, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "Primary", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 2332, + "name": "FilterValue", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 2333, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2254, + "typeArguments": [ + { + "type": "reference", + "target": 2334, + "typeArguments": [ + { + "type": "reference", + "target": 2333, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "FilterValue2", + "package": "@medusajs/types" + } + ], + "name": "OperatorMap", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 2334, + "typeArguments": [ + { + "type": "reference", + "target": 2333, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "FilterValue2", + "package": "@medusajs/types" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": 2334, + "typeArguments": [ + { + "type": "reference", + "target": 2333, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + ], + "name": "FilterValue2", + "package": "@medusajs/types" + } + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 2283, + "name": "PrevLimit", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "tuple", + "elements": [ + { + "type": "intrinsic", + "name": "never" + }, + { + "type": "literal", + "value": 1 + }, + { + "type": "literal", + "value": 2 + }, + { + "type": "literal", + "value": 3 + } + ] + } + }, + { + "id": 2284, + "name": "Order", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 2285, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "type": { + "type": "mapped", + "parameter": "key", + "parameterType": { + "type": "typeOperator", + "operator": "keyof", + "target": { + "type": "reference", + "target": 2285, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + "templateType": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "ASC" + }, + { + "type": "literal", + "value": "DESC" + }, + { + "type": "reference", + "target": 2284, + "typeArguments": [ + { + "type": "conditional", + "checkType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "key" + }, + "name": "key", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 2285, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + "extendsType": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "any" + } + }, + "trueType": { + "type": "indexedAccess", + "indexType": { + "type": "literal", + "value": 0 + }, + "objectType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "key" + }, + "name": "key", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 2285, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + }, + "falseType": { + "type": "indexedAccess", + "indexType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "key" + }, + "name": "key", + "package": "@medusajs/types", + "refersToTypeParameter": true + }, + "objectType": { + "type": "reference", + "target": 2285, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + } + } + ], + "name": "Order", + "package": "@medusajs/types" + } + ] + }, + "optionalModifier": "+" + } + }, + { + "id": 989, + "name": "EventBusTypes", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 990, + "name": "Subscriber", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 995, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 991, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 992, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 993, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 995, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + { + "id": 994, + "name": "eventName", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 996, + "name": "SubscriberContext", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 997, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 998, + "name": "subscriberId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 998 + ] + } + ] + } + } + }, + { + "id": 999, + "name": "SubscriberDescriptor", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1000, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1001, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1002, + "name": "subscriber", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 990, + "name": "Subscriber", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1001, + 1002 + ] + } + ] + } + } + }, + { + "id": 1003, + "name": "EventHandler", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 1008, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1004, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1005, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1006, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1008, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + { + "id": 1007, + "name": "eventName", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 1009, + "name": "EmitData", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 1014, + "name": "T", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1010, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1011, + "name": "eventName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1012, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1014, + "name": "T", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + { + "id": 1013, "name": "options", "variant": "declaration", "kind": 1024, @@ -7715,72 +23393,22 @@ }, "type": { "type": "reference", - "target": 422, + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, "typeArguments": [ { - "type": "reference", - "target": 436, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true + "type": "intrinsic", + "name": "string" }, { "type": "intrinsic", - "name": "any" + "name": "unknown" } ], - "name": "OptionsQuery", - "package": "@medusajs/types" - } - }, - { - "id": 434, - "name": "where", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 412, - "typeArguments": [ - { - "type": "reference", - "target": 436, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "FilterQuery", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 412, - "typeArguments": [ - { - "type": "reference", - "target": 436, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "FilterQuery", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] + "name": "Record", + "package": "typescript" } } ], @@ -7788,8 +23416,9 @@ { "title": "Properties", "children": [ - 435, - 434 + 1011, + 1012, + 1013 ] } ] @@ -7797,81 +23426,28 @@ } }, { - "id": 540, - "name": "SoftDeletableEntityDateColumns", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "deleted_at" - }, - { - "type": "reference", - "target": 539, - "name": "EntityDateColumns", - "package": "@medusajs/types" - } - ] - } - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [ - 418, - 422, - 437, - 536, - 533, - 490 - ] - }, - { - "title": "Type Aliases", - "children": [ - 539, - 412, - 432, - 540 - ] - } - ] - }, - { - "id": 541, - "name": "EventBusTypes", - "variant": "declaration", - "kind": 4, - "flags": {}, - "children": [ - { - "id": 587, + "id": 1035, "name": "IEventBusModuleService", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 588, + "id": 1036, "name": "emit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 589, + "id": 1037, "name": "emit", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 590, + "id": 1038, "name": "T", "variant": "typeParam", "kind": 131072, @@ -7880,7 +23456,7 @@ ], "parameters": [ { - "id": 591, + "id": 1039, "name": "eventName", "variant": "param", "kind": 32768, @@ -7891,21 +23467,21 @@ } }, { - "id": 592, + "id": 1040, "name": "data", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 590, + "target": 1038, "name": "T", "package": "@medusajs/types", "refersToTypeParameter": true } }, { - "id": 593, + "id": 1041, "name": "options", "variant": "param", "kind": 32768, @@ -7950,14 +23526,14 @@ } }, { - "id": 594, + "id": 1042, "name": "emit", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 595, + "id": 1043, "name": "T", "variant": "typeParam", "kind": 131072, @@ -7966,7 +23542,7 @@ ], "parameters": [ { - "id": 596, + "id": 1044, "name": "data", "variant": "param", "kind": 32768, @@ -7975,11 +23551,11 @@ "type": "array", "elementType": { "type": "reference", - "target": 561, + "target": 1009, "typeArguments": [ { "type": "reference", - "target": 595, + "target": 1043, "name": "T", "package": "@medusajs/types", "refersToTypeParameter": true @@ -8010,21 +23586,21 @@ ] }, { - "id": 597, + "id": 1045, "name": "subscribe", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 598, + "id": 1046, "name": "subscribe", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 599, + "id": 1047, "name": "eventName", "variant": "param", "kind": 32768, @@ -8044,20 +23620,20 @@ } }, { - "id": 600, + "id": 1048, "name": "subscriber", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 542, + "target": 990, "name": "Subscriber", "package": "@medusajs/types" } }, { - "id": 601, + "id": 1049, "name": "context", "variant": "param", "kind": 32768, @@ -8066,7 +23642,7 @@ }, "type": { "type": "reference", - "target": 548, + "target": 996, "name": "SubscriberContext", "package": "@medusajs/types" } @@ -8080,21 +23656,21 @@ ] }, { - "id": 602, + "id": 1050, "name": "unsubscribe", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 603, + "id": 1051, "name": "unsubscribe", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 604, + "id": 1052, "name": "eventName", "variant": "param", "kind": 32768, @@ -8114,20 +23690,20 @@ } }, { - "id": 605, + "id": 1053, "name": "subscriber", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 542, + "target": 990, "name": "Subscriber", "package": "@medusajs/types" } }, { - "id": 606, + "id": 1054, "name": "context", "variant": "param", "kind": 32768, @@ -8136,7 +23712,7 @@ }, "type": { "type": "reference", - "target": 548, + "target": 996, "name": "SubscriberContext", "package": "@medusajs/types" } @@ -8154,36 +23730,176 @@ { "title": "Methods", "children": [ - 588, - 597, - 602 + 1036, + 1045, + 1050 ] } ] }, { - "id": 567, + "id": 1015, "name": "IEventBusService", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 578, + "id": 1016, + "name": "subscribe", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1017, + "name": "subscribe", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1018, + "name": "eventName", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "symbol" + } + ] + } + }, + { + "id": 1019, + "name": "subscriber", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 990, + "name": "Subscriber", + "package": "@medusajs/types" + } + }, + { + "id": 1020, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 996, + "name": "SubscriberContext", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + } + } + ] + }, + { + "id": 1021, + "name": "unsubscribe", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1022, + "name": "unsubscribe", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1023, + "name": "eventName", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "symbol" + } + ] + } + }, + { + "id": 1024, + "name": "subscriber", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 990, + "name": "Subscriber", + "package": "@medusajs/types" + } + }, + { + "id": 1025, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 996, + "name": "SubscriberContext", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + } + } + ] + }, + { + "id": 1026, "name": "emit", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 579, + "id": 1027, "name": "emit", "variant": "signature", "kind": 4096, "flags": {}, "typeParameter": [ { - "id": 580, + "id": 1028, "name": "T", "variant": "typeParam", "kind": 131072, @@ -8192,7 +23908,7 @@ ], "parameters": [ { - "id": 581, + "id": 1029, "name": "event", "variant": "param", "kind": 32768, @@ -8203,21 +23919,21 @@ } }, { - "id": 582, + "id": 1030, "name": "data", "variant": "param", "kind": 32768, "flags": {}, "type": { "type": "reference", - "target": 580, + "target": 1028, "name": "T", "package": "@medusajs/types", "refersToTypeParameter": true } }, { - "id": 583, + "id": 1031, "name": "options", "variant": "param", "kind": 32768, @@ -8249,161 +23965,21 @@ ] }, { - "id": 568, - "name": "subscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 569, - "name": "subscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 570, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 571, - "name": "subscriber", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 542, - "name": "Subscriber", - "package": "@medusajs/types" - } - }, - { - "id": 572, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 548, - "name": "SubscriberContext", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 573, - "name": "unsubscribe", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 574, - "name": "unsubscribe", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 575, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "symbol" - } - ] - } - }, - { - "id": 576, - "name": "subscriber", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 542, - "name": "Subscriber", - "package": "@medusajs/types" - } - }, - { - "id": 577, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 548, - "name": "SubscriberContext", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - }, - { - "id": 584, + "id": 1032, "name": "withTransaction", "variant": "declaration", "kind": 2048, "flags": {}, "signatures": [ { - "id": 585, + "id": 1033, "name": "withTransaction", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 586, + "id": 1034, "name": "transactionManager", "variant": "param", "kind": 32768, @@ -8427,14 +24003,14 @@ }, "inheritedFrom": { "type": "reference", - "target": 1060, + "target": 1662, "name": "ITransactionBaseService.withTransaction" } } ], "inheritedFrom": { "type": "reference", - "target": 1059, + "target": 1661, "name": "ITransactionBaseService.withTransaction" } } @@ -8443,406 +24019,59 @@ { "title": "Methods", "children": [ - 578, - 568, - 573, - 584 + 1016, + 1021, + 1026, + 1032 ] } ], "extendedTypes": [ { "type": "reference", - "target": 1058, + "target": 1660, "name": "ITransactionBaseService", "package": "@medusajs/types" } ] - }, - { - "id": 561, - "name": "EmitData", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 566, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 562, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 564, - "name": "data", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 566, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - }, - { - "id": 563, - "name": "eventName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 565, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 564, - 563, - 565 - ] - } - ] - } - } - }, - { - "id": 555, - "name": "EventHandler", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 560, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 556, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 557, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 558, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 560, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - }, - { - "id": 559, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 542, - "name": "Subscriber", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 547, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 543, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 544, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 545, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 547, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - }, - { - "id": 546, - "name": "eventName", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 548, - "name": "SubscriberContext", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 549, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 550, - "name": "subscriberId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 550 - ] - } - ] - } - } - }, - { - "id": 551, - "name": "SubscriberDescriptor", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 552, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 553, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 554, - "name": "subscriber", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 542, - "name": "Subscriber", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 553, - 554 - ] - } - ] - } - } } ], "groups": [ { "title": "Interfaces", "children": [ - 587, - 567 + 1035, + 1015 ] }, { "title": "Type Aliases", "children": [ - 561, - 555, - 542, - 548, - 551 + 990, + 996, + 999, + 1003, + 1009 ] } ] }, { - "id": 607, + "id": 1055, "name": "FeatureFlagTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 608, + "id": 1056, "name": "IFlagRouter", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 609, + "id": 1057, "name": "isFeatureEnabled", "variant": "declaration", "kind": 1024, @@ -8850,21 +24079,21 @@ "type": { "type": "reflection", "declaration": { - "id": 610, + "id": 1058, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 611, + "id": 1059, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 612, + "id": 1060, "name": "key", "variant": "param", "kind": 32768, @@ -8885,7 +24114,7 @@ } }, { - "id": 613, + "id": 1061, "name": "listFlags", "variant": "declaration", "kind": 1024, @@ -8893,21 +24122,21 @@ "type": { "type": "reflection", "declaration": { - "id": 614, + "id": 1062, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 615, + "id": 1063, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "type": { "type": "reference", - "target": 616, + "target": 1064, "name": "FeatureFlagsResponse", "package": "@medusajs/types" } @@ -8921,14 +24150,14 @@ { "title": "Properties", "children": [ - 609, - 613 + 1057, + 1061 ] } ] }, { - "id": 616, + "id": 1064, "name": "FeatureFlagsResponse", "variant": "declaration", "kind": 2097152, @@ -8944,14 +24173,14 @@ "elementType": { "type": "reflection", "declaration": { - "id": 617, + "id": 1065, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 618, + "id": 1066, "name": "key", "variant": "declaration", "kind": 1024, @@ -8962,7 +24191,7 @@ } }, { - "id": 619, + "id": 1067, "name": "value", "variant": "declaration", "kind": 1024, @@ -9001,8 +24230,8 @@ { "title": "Properties", "children": [ - 618, - 619 + 1066, + 1067 ] } ] @@ -9011,7 +24240,7 @@ } }, { - "id": 620, + "id": 1068, "name": "FlagSettings", "variant": "declaration", "kind": 2097152, @@ -9019,25 +24248,25 @@ "type": { "type": "reflection", "declaration": { - "id": 621, + "id": 1069, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 625, - "name": "default_val", + "id": 1070, + "name": "key", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", - "name": "boolean" + "name": "string" } }, { - "id": 623, + "id": 1071, "name": "description", "variant": "declaration", "kind": 1024, @@ -9048,7 +24277,7 @@ } }, { - "id": 624, + "id": 1072, "name": "env_key", "variant": "declaration", "kind": 1024, @@ -9059,14 +24288,14 @@ } }, { - "id": 622, - "name": "key", + "id": 1073, + "name": "default_val", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "intrinsic", - "name": "string" + "name": "boolean" } } ], @@ -9074,10 +24303,10 @@ { "title": "Properties", "children": [ - 625, - 623, - 624, - 622 + 1070, + 1071, + 1072, + 1073 ] } ] @@ -9089,34 +24318,2443 @@ { "title": "Interfaces", "children": [ - 608 + 1056 ] }, { "title": "Type Aliases", "children": [ - 616, - 620 + 1064, + 1068 ] } ] }, { - "id": 626, + "id": 1759, + "name": "FileServiceUploadResult", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Details of a file upload's result." + } + ] + }, + "children": [ + { + "id": 1760, + "name": "url", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The file's URL." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1761, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The file's key. This key is used in other operations,\nsuch as deleting a file." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1760, + 1761 + ] + } + ] + }, + { + "id": 1762, + "name": "FileServiceGetUploadStreamResult", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The relevant details to upload a file through a stream." + } + ] + }, + "children": [ + { + "id": 1763, + "name": "writeStream", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A [PassThrough](https://nodejs.org/api/stream.html#class-streampassthrough) write stream object to be used to write the file." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/@types/node/stream.d.ts", + "qualifiedName": "internal.PassThrough" + }, + "name": "PassThrough", + "package": "@types/node", + "qualifiedName": "internal.PassThrough" + } + }, + { + "id": 1764, + "name": "promise", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A promise that should resolved when the writing process is done to finish the upload." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 1765, + "name": "url", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The URL of the file once it’s uploaded." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1766, + "name": "fileKey", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The identifier of the file in the storage. For example, for a local file service, this can be the file's name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1763, + 1764, + 1765, + 1766 + ] + } + ] + }, + { + "id": 1767, + "name": "GetUploadedFileType", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of a file to retrieve." + } + ] + }, + "children": [ + { + "id": 1768, + "name": "fileKey", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The file's key." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1769, + "name": "isPrivate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the file is private." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1768, + 1769 + ] + } + ] + }, + { + "id": 1770, + "name": "DeleteFileType", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to remove." + } + ] + }, + "children": [ + { + "id": 1771, + "name": "fileKey", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The file's key. When uploading a file, the\nreturned key is used here." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1771 + ] + } + ] + }, + { + "id": 1772, + "name": "UploadStreamDescriptorType", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file being uploaded through a stream." + } + ] + }, + "children": [ + { + "id": 1773, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the file." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1774, + "name": "ext", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The extension of the file." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1775, + "name": "isPrivate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the file should be uploaded to a private bucket or location. By convention, the default value of this property is " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1773, + 1774, + 1775 + ] + } + ] + }, + { + "id": 1776, + "name": "JoinerRelationship", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1777, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1778, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1779, + "name": "foreignKey", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1780, + "name": "primaryKey", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1781, + "name": "serviceName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1782, + "name": "isInternalService", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1783, + "name": "inverse", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "In an inverted relationship the foreign key is on the other service and the primary key is on the current service" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1784, + "name": "isList", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Force the relationship to return a list" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1785, + "name": "args", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Extra arguments to pass to the remoteFetchData callback" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1778, + 1779, + 1780, + 1781, + 1782, + 1783, + 1784, + 1785 + ] + } + ] + } + } + }, + { + "id": 1786, + "name": "JoinerServiceConfigAlias", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1787, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + }, + { + "id": 1788, + "name": "args", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Extra arguments to pass to the remoteFetchData callback" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1787, + 1788 + ] + } + ] + }, + { + "id": 1789, + "name": "JoinerServiceConfig", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1790, + "name": "serviceName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1791, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Property name to use as entrypoint to the service" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1786, + "name": "JoinerServiceConfigAlias", + "package": "@medusajs/types" + }, + { + "type": "array", + "elementType": { + "type": "reference", + "target": 1786, + "name": "JoinerServiceConfigAlias", + "package": "@medusajs/types" + } + } + ] + } + }, + { + "id": 1792, + "name": "fieldAlias", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1793, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1794, + "name": "path", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1795, + "name": "forwardArgumentsOnPath", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1794, + 1795 + ] + } + ] + } + } + ] + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1796, + "name": "primaryKeys", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1797, + "name": "relationships", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1776, + "name": "JoinerRelationship", + "package": "@medusajs/types" + } + } + }, + { + "id": 1798, + "name": "extends", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 1799, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1800, + "name": "serviceName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1801, + "name": "relationship", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1776, + "name": "JoinerRelationship", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1800, + 1801 + ] + } + ] + } + } + } + }, + { + "id": 1802, + "name": "args", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Extra arguments to pass to the remoteFetchData callback" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1790, + 1791, + 1792, + 1796, + 1797, + 1798, + 1802 + ] + } + ] + }, + { + "id": 1803, + "name": "JoinerArgument", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1804, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1805, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1804, + 1805 + ] + } + ] + }, + { + "id": 1806, + "name": "JoinerDirective", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1807, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1808, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1807, + 1808 + ] + } + ] + }, + { + "id": 1809, + "name": "RemoteJoinerQuery", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1810, + "name": "service", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1811, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1812, + "name": "expands", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 1813, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1814, + "name": "property", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1815, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1816, + "name": "args", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1803, + "name": "JoinerArgument", + "package": "@medusajs/types" + } + } + }, + { + "id": 1817, + "name": "directives", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1818, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "indexSignature": { + "id": 1819, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "parameters": [ + { + "id": 1820, + "name": "field", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1806, + "name": "JoinerDirective", + "package": "@medusajs/types" + } + } + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1814, + 1815, + 1816, + 1817 + ] + } + ] + } + } + } + }, + { + "id": 1821, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1822, + "name": "args", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1803, + "name": "JoinerArgument", + "package": "@medusajs/types" + } + } + }, + { + "id": 1823, + "name": "directives", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1824, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "indexSignature": { + "id": 1825, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "parameters": [ + { + "id": 1826, + "name": "field", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1806, + "name": "JoinerDirective", + "package": "@medusajs/types" + } + } + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1810, + 1811, + 1812, + 1821, + 1822, + 1823 + ] + } + ] + }, + { + "id": 1827, + "name": "RemoteNestedExpands", + "variant": "declaration", + "kind": 256, + "flags": {}, + "indexSignature": { + "id": 1828, + "name": "__index", + "variant": "signature", + "kind": 8192, + "flags": {}, + "parameters": [ + { + "id": 1829, + "name": "key", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1830, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1831, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1832, + "name": "args", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1803, + "name": "JoinerArgument", + "package": "@medusajs/types" + } + } + }, + { + "id": 1833, + "name": "expands", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1827, + "name": "RemoteNestedExpands", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1831, + 1832, + 1833 + ] + } + ] + } + } + } + }, + { + "id": 1834, + "name": "RemoteExpandProperty", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1835, + "name": "property", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1836, + "name": "parent", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1837, + "name": "parentConfig", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1789, + "name": "JoinerServiceConfig", + "package": "@medusajs/types" + } + }, + { + "id": 1838, + "name": "serviceConfig", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1789, + "name": "JoinerServiceConfig", + "package": "@medusajs/types" + } + }, + { + "id": 1839, + "name": "fields", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1840, + "name": "args", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1803, + "name": "JoinerArgument", + "package": "@medusajs/types" + } + } + }, + { + "id": 1841, + "name": "expands", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1827, + "name": "RemoteNestedExpands", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1835, + 1836, + 1837, + 1838, + 1839, + 1840, + 1841 + ] + } + ] + }, + { + "id": 1842, + "name": "ILinkModule", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1843, + "name": "__joinerConfig", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1844, + "name": "__joinerConfig", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reference", + "target": 1219, + "name": "ModuleJoinerConfig", + "package": "@medusajs/types" + } + } + ] + }, + { + "id": 1845, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1846, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1847, + "name": "filters", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1848, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 1849, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1850, + "name": "listAndCount", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1851, + "name": "listAndCount", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1852, + "name": "filters", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1853, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 1854, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "tuple", + "elements": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1855, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1856, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1857, + "name": "primaryKeyOrBulkData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "array", + "elementType": { + "type": "tuple", + "elements": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "optional", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 1858, + "name": "foreignKeyData", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1859, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1860, + "name": "dismiss", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1861, + "name": "dismiss", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1862, + "name": "primaryKeyOrBulkData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + }, + { + "type": "array", + "elementType": { + "type": "tuple", + "elements": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ] + } + }, + { + "id": 1863, + "name": "foreignKeyData", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1864, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1865, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1866, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1867, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 1868, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1869, + "name": "softDelete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1870, + "name": "softDelete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1871, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 1872, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 981, + "name": "SoftDeleteReturn", + "package": "@medusajs/types" + } + }, + { + "id": 1873, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1874, + "name": "restore", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1875, + "name": "restore", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1876, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 1877, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 984, + "name": "RestoreReturn", + "package": "@medusajs/types" + } + }, + { + "id": 1878, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "name": "Record", + "package": "typescript" + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1843, + 1845, + 1850, + 1855, + 1860, + 1865, + 1869, + 1874 + ] + } + ] + }, + { + "id": 1074, "name": "LoggerTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 627, + "id": 1075, "name": "Logger", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 643, + "id": 1076, + "name": "panic", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1077, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1078, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1079, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 1080, + "name": "shouldLog", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1081, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1082, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1083, + "name": "level", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 1084, + "name": "setLogLevel", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1085, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1086, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1087, + "name": "level", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 1088, + "name": "unsetLogLevel", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1089, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1090, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 1091, "name": "activity", "variant": "declaration", "kind": 1024, @@ -9124,21 +26762,21 @@ "type": { "type": "reflection", "declaration": { - "id": 644, + "id": 1092, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 645, + "id": 1093, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 646, + "id": 1094, "name": "message", "variant": "param", "kind": 32768, @@ -9149,7 +26787,7 @@ } }, { - "id": 647, + "id": 1095, "name": "config", "variant": "param", "kind": 32768, @@ -9172,29 +26810,40 @@ } }, { - "id": 668, - "name": "debug", + "id": 1096, + "name": "progress", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 669, + "id": 1097, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 670, + "id": 1098, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 671, + "id": 1099, + "name": "activityId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1100, "name": "message", "variant": "param", "kind": 32768, @@ -9215,7 +26864,7 @@ } }, { - "id": 653, + "id": 1101, "name": "error", "variant": "declaration", "kind": 1024, @@ -9223,21 +26872,21 @@ "type": { "type": "reflection", "declaration": { - "id": 654, + "id": 1102, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 655, + "id": 1103, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 656, + "id": 1104, "name": "messageOrError", "variant": "param", "kind": 32768, @@ -9248,7 +26897,7 @@ } }, { - "id": 657, + "id": 1105, "name": "error", "variant": "param", "kind": 32768, @@ -9271,7 +26920,7 @@ } }, { - "id": 658, + "id": 1106, "name": "failure", "variant": "declaration", "kind": 1024, @@ -9279,21 +26928,21 @@ "type": { "type": "reflection", "declaration": { - "id": 659, + "id": 1107, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 660, + "id": 1108, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 661, + "id": 1109, "name": "activityId", "variant": "param", "kind": 32768, @@ -9304,7 +26953,7 @@ } }, { - "id": 662, + "id": 1110, "name": "message", "variant": "param", "kind": 32768, @@ -9325,7 +26974,104 @@ } }, { - "id": 672, + "id": 1111, + "name": "success", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1112, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1113, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1114, + "name": "activityId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1115, + "name": "message", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 1116, + "name": "debug", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1117, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1118, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1119, + "name": "message", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 1120, "name": "info", "variant": "declaration", "kind": 1024, @@ -9333,21 +27079,21 @@ "type": { "type": "reflection", "declaration": { - "id": 673, + "id": 1121, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 674, + "id": 1122, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 675, + "id": 1123, "name": "message", "variant": "param", "kind": 32768, @@ -9368,7 +27114,50 @@ } }, { - "id": 680, + "id": 1124, + "name": "warn", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1125, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1126, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1127, + "name": "message", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "void" + } + } + ] + } + } + }, + { + "id": 1128, "name": "log", "variant": "declaration", "kind": 1024, @@ -9376,21 +27165,21 @@ "type": { "type": "reflection", "declaration": { - "id": 681, + "id": 1129, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 682, + "id": 1130, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 683, + "id": 1131, "name": "args", "variant": "param", "kind": 32768, @@ -9414,335 +27203,25 @@ ] } } - }, - { - "id": 628, - "name": "panic", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 629, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 630, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 631, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 648, - "name": "progress", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 649, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 650, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 651, - "name": "activityId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 652, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 636, - "name": "setLogLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 637, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 638, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 639, - "name": "level", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 632, - "name": "shouldLog", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 633, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 634, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 635, - "name": "level", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 663, - "name": "success", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 664, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 665, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 666, - "name": "activityId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 667, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 640, - "name": "unsetLogLevel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 641, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 642, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } - }, - { - "id": 676, - "name": "warn", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 677, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 678, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 679, - "name": "message", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "void" - } - } - ] - } - } } ], "groups": [ { "title": "Properties", "children": [ - 643, - 668, - 653, - 658, - 672, - 680, - 628, - 648, - 636, - 632, - 663, - 640, - 676 + 1076, + 1080, + 1084, + 1088, + 1091, + 1096, + 1101, + 1106, + 1111, + 1116, + 1120, + 1124, + 1128 ] } ] @@ -9752,478 +27231,27 @@ { "title": "Interfaces", "children": [ - 627 + 1075 ] } ] }, { - "id": 684, + "id": 1132, "name": "ModulesSdkTypes", "variant": "declaration", "kind": 4, "flags": {}, "children": [ { - "id": 695, - "name": "MODULE_RESOURCE_TYPE", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 697, - "name": "ISOLATED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "isolated" - } - }, - { - "id": 696, - "name": "SHARED", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "shared" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 697, - 696 - ] - } - ] - }, - { - "id": 692, - "name": "MODULE_SCOPE", - "variant": "declaration", - "kind": 8, - "flags": {}, - "children": [ - { - "id": 694, - "name": "EXTERNAL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "external" - } - }, - { - "id": 693, - "name": "INTERNAL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "internal" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 694, - 693 - ] - } - ] - }, - { - "id": 843, - "name": "IModuleService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 846, - "name": "__hooks", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 847, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 848, - "name": "onApplicationStart", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 849, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 850, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 848 - ] - } - ] - } - } - }, - { - "id": 844, - "name": "__joinerConfig", - "variant": "declaration", - "kind": 2048, - "flags": { - "isOptional": true - }, - "signatures": [ - { - "id": 845, - "name": "__joinerConfig", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": 771, - "name": "ModuleJoinerConfig", - "package": "@medusajs/types" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 846 - ] - }, - { - "title": "Methods", - "children": [ - 844 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 16, - "name": "IAuthenticationModuleService" - }, - { - "type": "reference", - "target": 195, - "name": "ICartModuleService" - }, - { - "type": "reference", - "target": 940, - "name": "IPromotionModuleService" - } - ] - }, - { - "id": 816, - "name": "ModuleServiceInitializeOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 817, - "name": "database", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 818, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 820, - "name": "clientUrl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 819, - "name": "connection", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Forces to use a shared knex connection" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 826, - "name": "database", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 828, - "name": "debug", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 827, - "name": "driverOptions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 822, - "name": "host", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 825, - "name": "password", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 829, - "name": "pool", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 823, - "name": "port", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 821, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 824, - "name": "user", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 820, - 819, - 826, - 828, - 827, - 822, - 825, - 829, - 823, - 821, - 824 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 817 - ] - } - ] - }, - { - "id": 685, + "id": 1133, "name": "Constructor", "variant": "declaration", "kind": 2097152, "flags": {}, "typeParameters": [ { - "id": 689, + "id": 1137, "name": "T", "variant": "typeParam", "kind": 131072, @@ -10233,21 +27261,21 @@ "type": { "type": "reflection", "declaration": { - "id": 686, + "id": 1134, "name": "__type", "variant": "declaration", "kind": 512, "flags": {}, "signatures": [ { - "id": 687, + "id": 1135, "name": "__type", "variant": "signature", "kind": 16384, "flags": {}, "parameters": [ { - "id": 688, + "id": 1136, "name": "args", "variant": "param", "kind": 32768, @@ -10265,7 +27293,7 @@ ], "type": { "type": "reference", - "target": 689, + "target": 1137, "name": "T", "package": "@medusajs/types", "refersToTypeParameter": true @@ -10276,632 +27304,7 @@ } }, { - "id": 708, - "name": "ExternalModuleDeclaration", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 709, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 718, - "name": "alias", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If multiple modules are registered with the same key, the alias can be used to differentiate them" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 711, - "name": "definition", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 728, - "name": "ModuleDefinition", - "package": "@medusajs/types" - } - }, - { - "id": 719, - "name": "main", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the module is the main module for the key when multiple ones are registered" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 717, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 710, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 694, - "name": "MODULE_SCOPE.EXTERNAL", - "package": "@medusajs/types" - } - }, - { - "id": 712, - "name": "server", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 713, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 716, - "name": "keepAlive", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 714, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "literal", - "value": "http" - } - }, - { - "id": 715, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 716, - 714, - 715 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 718, - 711, - 719, - 717, - 710, - 712 - ] - } - ] - } - } - }, - { - "id": 698, - "name": "InternalModuleDeclaration", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 699, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 706, - "name": "alias", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If multiple modules are registered with the same key, the alias can be used to differentiate them" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 703, - "name": "definition", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 728, - "name": "ModuleDefinition", - "package": "@medusajs/types" - } - }, - { - "id": 702, - "name": "dependencies", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 707, - "name": "main", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the module is the main module for the key when multiple ones are registered" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 705, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 704, - "name": "resolve", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 701, - "name": "resources", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 695, - "name": "MODULE_RESOURCE_TYPE", - "package": "@medusajs/types" - } - }, - { - "id": 700, - "name": "scope", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 693, - "name": "MODULE_SCOPE.INTERNAL", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 706, - 703, - 702, - 707, - 705, - 704, - 701, - 700 - ] - } - ] - } - } - }, - { - "id": 740, - "name": "LinkModuleDefinition", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 741, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 746, - "name": "defaultModuleDeclaration", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 698, - "name": "InternalModuleDeclaration", - "package": "@medusajs/types" - } - }, - { - "id": 745, - "name": "dependencies", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 742, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 744, - "name": "label", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 743, - "name": "registrationName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 746, - 745, - 742, - 744, - 743 - ] - } - ] - } - } - }, - { - "id": 752, - "name": "LoadedModule", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "intrinsic", - "name": "unknown" - }, - { - "type": "reflection", - "declaration": { - "id": 753, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 755, - "name": "__definition", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 728, - "name": "ModuleDefinition", - "package": "@medusajs/types" - } - }, - { - "id": 754, - "name": "__joinerConfig", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 771, - "name": "ModuleJoinerConfig", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 755, - 754 - ] - } - ] - } - } - ] - } - }, - { - "id": 756, - "name": "LoaderOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 761, - "name": "TOptions", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 757, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 758, - "name": "container", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 372, - "name": "MedusaContainer", - "package": "@medusajs/types" - } - }, - { - "id": 760, - "name": "logger", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 627, - "name": "Logger", - "package": "@medusajs/types" - } - }, - { - "id": 759, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 761, - "name": "TOptions", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 758, - 760, - 759 - ] - } - ] - } - } - }, - { - "id": 690, + "id": 1138, "name": "LogLevel", "variant": "declaration", "kind": 2097152, @@ -10941,7 +27344,7 @@ } }, { - "id": 691, + "id": 1139, "name": "LoggerOptions", "variant": "declaration", "kind": 2097152, @@ -10961,7 +27364,7 @@ "type": "array", "elementType": { "type": "reference", - "target": 690, + "target": 1138, "name": "LogLevel", "package": "@medusajs/types" } @@ -10970,106 +27373,605 @@ } }, { - "id": 837, - "name": "ModuleBootstrapDeclaration", + "id": 1140, + "name": "MODULE_SCOPE", "variant": "declaration", - "kind": 2097152, + "kind": 8, "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 698, - "name": "InternalModuleDeclaration", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 708, - "name": "ExternalModuleDeclaration", - "package": "@medusajs/types" + "children": [ + { + "id": 1141, + "name": "INTERNAL", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "internal" } - ] - } + }, + { + "id": 1142, + "name": "EXTERNAL", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "external" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1141, + 1142 + ] + } + ] }, { - "id": 747, - "name": "ModuleConfig", + "id": 1143, + "name": "MODULE_RESOURCE_TYPE", + "variant": "declaration", + "kind": 8, + "flags": {}, + "children": [ + { + "id": 1144, + "name": "SHARED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "shared" + } + }, + { + "id": 1145, + "name": "ISOLATED", + "variant": "declaration", + "kind": 16, + "flags": {}, + "type": { + "type": "literal", + "value": "isolated" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 1144, + 1145 + ] + } + ] + }, + { + "id": 1146, + "name": "InternalModuleDeclaration", "variant": "declaration", "kind": 2097152, "flags": {}, "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": 1720, - "name": "ModuleDeclaration", - "package": "@medusajs/types" - }, - { - "type": "reflection", - "declaration": { - "id": 748, - "name": "__type", + "type": "reflection", + "declaration": { + "id": 1147, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1148, + "name": "scope", "variant": "declaration", - "kind": 65536, + "kind": 1024, "flags": {}, + "type": { + "type": "reference", + "target": 1141, + "name": "MODULE_SCOPE.INTERNAL", + "package": "@medusajs/types" + } + }, + { + "id": 1149, + "name": "resources", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1143, + "name": "MODULE_RESOURCE_TYPE", + "package": "@medusajs/types" + } + }, + { + "id": 1150, + "name": "dependencies", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1151, + "name": "definition", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1176, + "name": "ModuleDefinition", + "package": "@medusajs/types" + } + }, + { + "id": 1152, + "name": "resolve", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1153, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1154, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If multiple modules are registered with the same key, the alias can be used to differentiate them" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1155, + "name": "main", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the module is the main module for the key when multiple ones are registered" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", "children": [ - { - "id": 751, - "name": "definition", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 728, - "name": "ModuleDefinition", - "package": "@medusajs/types" - } - }, - { - "id": 749, - "name": "module", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 750, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 751, - 749, - 750 - ] - } + 1148, + 1149, + 1150, + 1151, + 1152, + 1153, + 1154, + 1155 ] } - } - ] + ] + } } }, { - "id": 728, + "id": 1156, + "name": "ExternalModuleDeclaration", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1157, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1158, + "name": "scope", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1142, + "name": "MODULE_SCOPE.EXTERNAL", + "package": "@medusajs/types" + } + }, + { + "id": 1159, + "name": "definition", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1176, + "name": "ModuleDefinition", + "package": "@medusajs/types" + } + }, + { + "id": 1160, + "name": "server", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1161, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1162, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "literal", + "value": "http" + } + }, + { + "id": 1163, + "name": "url", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1164, + "name": "keepAlive", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1162, + 1163, + 1164 + ] + } + ] + } + } + }, + { + "id": 1165, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1166, + "name": "alias", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If multiple modules are registered with the same key, the alias can be used to differentiate them" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1167, + "name": "main", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the module is the main module for the key when multiple ones are registered" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1158, + 1159, + 1160, + 1165, + 1166, + 1167 + ] + } + ] + } + } + }, + { + "id": 1168, + "name": "ModuleResolution", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1169, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1170, + "name": "resolutionPath", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": false + } + ] + } + }, + { + "id": 1171, + "name": "definition", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1176, + "name": "ModuleDefinition", + "package": "@medusajs/types" + } + }, + { + "id": 1172, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1173, + "name": "dependencies", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1174, + "name": "moduleDeclaration", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1146, + "name": "InternalModuleDeclaration", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 1156, + "name": "ExternalModuleDeclaration", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 1175, + "name": "moduleExports", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1250, + "name": "ModuleExports", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1170, + 1171, + 1172, + 1173, + 1174, + 1175 + ] + } + ] + } + } + }, + { + "id": 1176, "name": "ModuleDefinition", "variant": "declaration", "kind": 2097152, @@ -11077,14 +27979,67 @@ "type": { "type": "reflection", "declaration": { - "id": 729, + "id": 1177, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 734, + "id": 1178, + "name": "key", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1179, + "name": "registrationName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1180, + "name": "defaultPackage", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": false + } + ] + } + }, + { + "id": 1181, + "name": "label", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1182, "name": "canOverride", "variant": "declaration", "kind": 1024, @@ -11111,93 +28066,7 @@ } }, { - "id": 739, - "name": "defaultModuleDeclaration", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 698, - "name": "InternalModuleDeclaration", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 708, - "name": "ExternalModuleDeclaration", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 732, - "name": "defaultPackage", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ] - } - }, - { - "id": 738, - "name": "dependencies", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 737, - "name": "isLegacy", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 736, - "name": "isQueryable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 735, + "id": 1183, "name": "isRequired", "variant": "declaration", "kind": 1024, @@ -11224,7 +28093,109 @@ } }, { - "id": 730, + "id": 1184, + "name": "isQueryable", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1185, + "name": "isLegacy", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1186, + "name": "dependencies", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1187, + "name": "defaultModuleDeclaration", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1146, + "name": "InternalModuleDeclaration", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 1156, + "name": "ExternalModuleDeclaration", + "package": "@medusajs/types" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1178, + 1179, + 1180, + 1181, + 1182, + 1183, + 1184, + 1185, + 1186, + 1187 + ] + } + ] + } + } + }, + { + "id": 1188, + "name": "LinkModuleDefinition", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1189, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1190, "name": "key", "variant": "declaration", "kind": 1024, @@ -11235,7 +28206,18 @@ } }, { - "id": 733, + "id": 1191, + "name": "registrationName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1192, "name": "label", "variant": "declaration", "kind": 1024, @@ -11246,73 +28228,8 @@ } }, { - "id": 731, - "name": "registrationName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 734, - 739, - 732, - 738, - 737, - 736, - 735, - 730, - 733, - 731 - ] - } - ] - } - } - }, - { - "id": 802, - "name": "ModuleExports", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 803, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 805, - "name": "loaders", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 762, - "name": "ModuleLoaderFunction", - "package": "@medusajs/types" - } - } - }, - { - "id": 806, - "name": "migrations", + "id": 1193, + "name": "dependencies", "variant": "declaration", "kind": 1024, "flags": { @@ -11322,237 +28239,33 @@ "type": "array", "elementType": { "type": "intrinsic", - "name": "any" + "name": "string" } } }, { - "id": 807, - "name": "models", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 685, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Constructor", - "package": "@medusajs/types" - } - } - }, - { - "id": 804, - "name": "service", + "id": 1194, + "name": "defaultModuleDeclaration", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 685, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Constructor", + "target": 1146, + "name": "InternalModuleDeclaration", "package": "@medusajs/types" } - }, - { - "id": 812, - "name": "revertMigration", - "variant": "declaration", - "kind": 2048, - "flags": { - "isOptional": true - }, - "signatures": [ - { - "id": 813, - "name": "revertMigration", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 814, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 756, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "LoaderOptions", - "package": "@medusajs/types" - } - }, - { - "id": 815, - "name": "moduleDeclaration", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 698, - "name": "InternalModuleDeclaration", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 808, - "name": "runMigrations", - "variant": "declaration", - "kind": 2048, - "flags": { - "isOptional": true - }, - "signatures": [ - { - "id": 809, - "name": "runMigrations", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 810, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 756, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "LoaderOptions", - "package": "@medusajs/types" - } - }, - { - "id": 811, - "name": "moduleDeclaration", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 698, - "name": "InternalModuleDeclaration", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] } ], "groups": [ { "title": "Properties", "children": [ - 805, - 806, - 807, - 804 - ] - }, - { - "title": "Methods", - "children": [ - 812, - 808 + 1190, + 1191, + 1192, + 1193, + 1194 ] } ] @@ -11560,7 +28273,379 @@ } }, { - "id": 771, + "id": 1195, + "name": "ModuleConfig", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": 2316, + "name": "ModuleDeclaration", + "package": "@medusajs/types" + }, + { + "type": "reflection", + "declaration": { + "id": 1196, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1197, + "name": "module", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1198, + "name": "path", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1199, + "name": "definition", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1176, + "name": "ModuleDefinition", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1197, + 1198, + 1199 + ] + } + ] + } + } + ] + } + }, + { + "id": 1200, + "name": "LoadedModule", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "intrinsic", + "name": "unknown" + }, + { + "type": "reflection", + "declaration": { + "id": 1201, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1202, + "name": "__joinerConfig", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1219, + "name": "ModuleJoinerConfig", + "package": "@medusajs/types" + } + }, + { + "id": 1203, + "name": "__definition", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1176, + "name": "ModuleDefinition", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1202, + 1203 + ] + } + ] + } + } + ] + } + }, + { + "id": 1204, + "name": "LoaderOptions", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "typeParameters": [ + { + "id": 1209, + "name": "TOptions", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reflection", + "declaration": { + "id": 1205, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1206, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 820, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 1207, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1209, + "name": "TOptions", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + { + "id": 1208, + "name": "logger", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1075, + "name": "Logger", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1206, + 1207, + 1208 + ] + } + ] + } + } + }, + { + "id": 1210, + "name": "ModuleLoaderFunction", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1211, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1212, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1213, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1204, + "name": "LoaderOptions", + "package": "@medusajs/types" + } + }, + { + "id": 1214, + "name": "moduleDeclaration", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1146, + "name": "InternalModuleDeclaration", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 1215, + "name": "ModulesResponse", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 1216, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1217, + "name": "module", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1218, + "name": "resolution", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": false + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1217, + 1218 + ] + } + ] + } + } + } + }, + { + "id": 1219, "name": "ModuleJoinerConfig", "variant": "declaration", "kind": 2097152, @@ -11577,7 +28662,7 @@ "typeArguments": [ { "type": "reference", - "target": 1200, + "target": 1789, "name": "JoinerServiceConfig", "package": "@medusajs/types" }, @@ -11609,14 +28694,297 @@ { "type": "reflection", "declaration": { - "id": 772, + "id": 1220, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 788, + "id": 1221, + "name": "schema", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "GraphQL schema for the all module's available entities and fields" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1222, + "name": "relationships", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1246, + "name": "ModuleJoinerRelationship", + "package": "@medusajs/types" + } + } + }, + { + "id": 1223, + "name": "extends", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 1224, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1225, + "name": "serviceName", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1226, + "name": "fieldAlias", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 1227, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1228, + "name": "path", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1229, + "name": "forwardArgumentsOnPath", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1228, + 1229 + ] + } + ] + } + } + ] + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1230, + "name": "relationship", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1246, + "name": "ModuleJoinerRelationship", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1225, + 1226, + 1230 + ] + } + ] + } + } + } + }, + { + "id": 1231, + "name": "serviceName", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1232, + "name": "primaryKeys", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1233, + "name": "isLink", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If the module is a link module" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1234, + "name": "linkableKeys", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Keys that can be used to link to other modules. e.g { product_id: \"Product\" } \"Product\" being the entity it refers to" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1235, + "name": "isReadOnlyLink", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true it expands a RemoteQuery property but doesn't create a pivot table" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1236, "name": "databaseConfig", "variant": "declaration", "kind": 1024, @@ -11626,14 +28994,56 @@ "type": { "type": "reflection", "declaration": { - "id": 789, + "id": 1237, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 792, + "id": 1238, + "name": "tableName", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Name of the pivot table. If not provided it is auto generated" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1239, + "name": "idPrefix", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Prefix for the id column. If not provided it is \"link\"" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1240, "name": "extraFields", "variant": "declaration", "kind": 1024, @@ -11654,76 +29064,14 @@ { "type": "reflection", "declaration": { - "id": 793, + "id": 1241, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 795, - "name": "defaultValue", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 796, - "name": "nullable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 797, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Mikro-orm options for the column" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 794, + "id": 1242, "name": "type", "variant": "declaration", "kind": 1024, @@ -11817,16 +29165,78 @@ } ] } + }, + { + "id": 1243, + "name": "defaultValue", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1244, + "name": "nullable", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1245, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Mikro-orm options for the column" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } } ], "groups": [ { "title": "Properties", "children": [ - 795, - 796, - 797, - 794 + 1242, + 1243, + 1244, + 1245 ] } ] @@ -11836,360 +29246,35 @@ "name": "Record", "package": "typescript" } - }, - { - "id": 791, - "name": "idPrefix", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Prefix for the id column. If not provided it is \"link\"" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 790, - "name": "tableName", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Name of the pivot table. If not provided it is auto generated" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ { "title": "Properties", "children": [ - 792, - 791, - 790 + 1238, + 1239, + 1240 ] } ] } } - }, - { - "id": 775, - "name": "extends", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 776, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 778, - "name": "fieldAlias", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 779, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 781, - "name": "forwardArgumentsOnPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 780, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 781, - 780 - ] - } - ] - } - } - ] - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 782, - "name": "relationship", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 798, - "name": "ModuleJoinerRelationship", - "package": "@medusajs/types" - } - }, - { - "id": 777, - "name": "serviceName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 778, - 782, - 777 - ] - } - ] - } - } - } - }, - { - "id": 785, - "name": "isLink", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If the module is a link module" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 787, - "name": "isReadOnlyLink", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true it expands a RemoteQuery property but doesn't create a pivot table" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 786, - "name": "linkableKeys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Keys that can be used to link to other modules. e.g { product_id: \"Product\" } \"Product\" being the entity it refers to" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 784, - "name": "primaryKeys", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 774, - "name": "relationships", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 798, - "name": "ModuleJoinerRelationship", - "package": "@medusajs/types" - } - } - }, - { - "id": 773, - "name": "schema", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "GraphQL schema for the all module's available entities and fields" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 783, - "name": "serviceName", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ { "title": "Properties", "children": [ - 788, - 775, - 785, - 787, - 786, - 784, - 774, - 773, - 783 + 1221, + 1222, + 1223, + 1231, + 1232, + 1233, + 1234, + 1235, + 1236 ] } ] @@ -12199,7 +29284,7 @@ } }, { - "id": 798, + "id": 1246, "name": "ModuleJoinerRelationship", "variant": "declaration", "kind": 2097152, @@ -12209,42 +29294,21 @@ "types": [ { "type": "reference", - "target": 1187, + "target": 1776, "name": "JoinerRelationship", "package": "@medusajs/types" }, { "type": "reflection", "declaration": { - "id": 799, + "id": 1247, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 801, - "name": "deleteCascade", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the link joiner will cascade deleting the relationship" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 800, + "id": 1248, "name": "isInternalService", "variant": "declaration", "kind": 1024, @@ -12263,14 +29327,35 @@ "type": "intrinsic", "name": "boolean" } + }, + { + "id": 1249, + "name": "deleteCascade", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If true, the link joiner will cascade deleting the relationship" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } } ], "groups": [ { "title": "Properties", "children": [ - 801, - 800 + 1248, + 1249 ] } ] @@ -12280,107 +29365,60 @@ } }, { - "id": 762, - "name": "ModuleLoaderFunction", + "id": 1250, + "name": "ModuleExports", "variant": "declaration", "kind": 2097152, "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 763, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 764, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 765, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 756, - "name": "LoaderOptions", - "package": "@medusajs/types" - } - }, - { - "id": 766, - "name": "moduleDeclaration", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 698, - "name": "InternalModuleDeclaration", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - }, - { - "id": 720, - "name": "ModuleResolution", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 721, + "id": 1251, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 723, - "name": "definition", + "id": 1252, + "name": "service", "variant": "declaration", "kind": 1024, "flags": {}, "type": { "type": "reference", - "target": 728, - "name": "ModuleDefinition", + "target": 1133, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Constructor", "package": "@medusajs/types" } }, { - "id": 725, - "name": "dependencies", + "id": 1253, + "name": "loaders", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1210, + "name": "ModuleLoaderFunction", + "package": "@medusajs/types" + } + } + }, + { + "id": 1254, + "name": "migrations", "variant": "declaration", "kind": 1024, "flags": { @@ -12390,110 +29428,218 @@ "type": "array", "elementType": { "type": "intrinsic", - "name": "string" + "name": "any" } } }, { - "id": 726, - "name": "moduleDeclaration", + "id": 1255, + "name": "models", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, "type": { - "type": "union", - "types": [ - { + "type": "array", + "elementType": { + "type": "reference", + "target": 1133, + "typeArguments": [ + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Constructor", + "package": "@medusajs/types" + } + } + }, + { + "id": 1256, + "name": "runMigrations", + "variant": "declaration", + "kind": 2048, + "flags": { + "isOptional": true + }, + "signatures": [ + { + "id": 1257, + "name": "runMigrations", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1258, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1204, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "LoaderOptions", + "package": "@medusajs/types" + } + }, + { + "id": 1259, + "name": "moduleDeclaration", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1146, + "name": "InternalModuleDeclaration", + "package": "@medusajs/types" + } + } + ], + "type": { "type": "reference", - "target": 698, - "name": "InternalModuleDeclaration", - "package": "@medusajs/types" - }, - { + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1260, + "name": "revertMigration", + "variant": "declaration", + "kind": 2048, + "flags": { + "isOptional": true + }, + "signatures": [ + { + "id": 1261, + "name": "revertMigration", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1262, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1204, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ], + "name": "LoaderOptions", + "package": "@medusajs/types" + } + }, + { + "id": 1263, + "name": "moduleDeclaration", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1146, + "name": "InternalModuleDeclaration", + "package": "@medusajs/types" + } + } + ], + "type": { "type": "reference", - "target": 708, - "name": "ExternalModuleDeclaration", - "package": "@medusajs/types" + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" } - ] - } - }, - { - "id": 727, - "name": "moduleExports", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 802, - "name": "ModuleExports", - "package": "@medusajs/types" - } - }, - { - "id": 724, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 722, - "name": "resolutionPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ] - } + } + ] } ], "groups": [ { "title": "Properties", "children": [ - 723, - 725, - 726, - 727, - 724, - 722 + 1252, + 1253, + 1254, + 1255 + ] + }, + { + "title": "Methods", + "children": [ + 1256, + 1260 ] } ] @@ -12501,7 +29647,242 @@ } }, { - "id": 830, + "id": 1264, + "name": "ModuleServiceInitializeOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1265, + "name": "database", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1266, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1267, + "name": "connection", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Forces to use a shared knex connection" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 1268, + "name": "clientUrl", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1269, + "name": "schema", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1270, + "name": "host", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1271, + "name": "port", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1272, + "name": "user", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1273, + "name": "password", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1274, + "name": "database", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1275, + "name": "driverOptions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1276, + "name": "debug", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1277, + "name": "pool", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1267, + 1268, + 1269, + 1270, + 1271, + 1272, + 1273, + 1274, + 1275, + 1276, + 1277 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1265 + ] + } + ] + }, + { + "id": 1278, "name": "ModuleServiceInitializeCustomDataLayerOptions", "variant": "declaration", "kind": 2097152, @@ -12509,14 +29890,14 @@ "type": { "type": "reflection", "declaration": { - "id": 831, + "id": 1279, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 832, + "id": 1280, "name": "manager", "variant": "declaration", "kind": 1024, @@ -12529,7 +29910,7 @@ } }, { - "id": 833, + "id": 1281, "name": "repositories", "variant": "declaration", "kind": 1024, @@ -12539,20 +29920,20 @@ "type": { "type": "reflection", "declaration": { - "id": 834, + "id": 1282, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "indexSignature": { - "id": 835, + "id": 1283, "name": "__index", "variant": "signature", "kind": 8192, "flags": {}, "parameters": [ { - "id": 836, + "id": 1284, "name": "key", "variant": "param", "kind": 32768, @@ -12565,11 +29946,11 @@ ], "type": { "type": "reference", - "target": 685, + "target": 1133, "typeArguments": [ { "type": "reference", - "target": 437, + "target": 885, "name": "RepositoryService", "package": "@medusajs/types" } @@ -12586,8 +29967,8 @@ { "title": "Properties", "children": [ - 832, - 833 + 1280, + 1281 ] } ] @@ -12595,69 +29976,31 @@ } }, { - "id": 767, - "name": "ModulesResponse", + "id": 1285, + "name": "ModuleBootstrapDeclaration", "variant": "declaration", "kind": 2097152, "flags": {}, "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 768, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 769, - "name": "module", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 770, - "name": "resolution", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": false - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 769, - 770 - ] - } - ] + "type": "union", + "types": [ + { + "type": "reference", + "target": 1146, + "name": "InternalModuleDeclaration", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 1156, + "name": "ExternalModuleDeclaration", + "package": "@medusajs/types" } - } + ] } }, { - "id": 838, + "id": 1286, "name": "RemoteQueryFunction", "variant": "declaration", "kind": 2097152, @@ -12665,21 +30008,21 @@ "type": { "type": "reflection", "declaration": { - "id": 839, + "id": 1287, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 840, + "id": 1288, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, "parameters": [ { - "id": 841, + "id": 1289, "name": "query", "variant": "param", "kind": 32768, @@ -12693,7 +30036,7 @@ }, { "type": "reference", - "target": 1220, + "target": 1809, "name": "RemoteJoinerQuery", "package": "@medusajs/types" }, @@ -12705,7 +30048,7 @@ } }, { - "id": 842, + "id": 1290, "name": "variables", "variant": "param", "kind": 32768, @@ -12761,1337 +30104,40 @@ ] } } - } - ], - "groups": [ - { - "title": "Enumerations", - "children": [ - 695, - 692 - ] }, { - "title": "Interfaces", - "children": [ - 843, - 816 - ] - }, - { - "title": "Type Aliases", - "children": [ - 685, - 708, - 698, - 740, - 752, - 756, - 690, - 691, - 837, - 747, - 728, - 802, - 771, - 798, - 762, - 720, - 830, - 767, - 838 - ] - } - ] - }, - { - "id": 851, - "name": "PromotionTypes", - "variant": "declaration", - "kind": 4, - "flags": {}, - "children": [ - { - "id": 855, - "name": "ApplicationMethodDTO", + "id": 1291, + "name": "IModuleService", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 859, - "name": "allocation", + "id": 1292, + "name": "__joinerConfig", "variant": "declaration", - "kind": 1024, + "kind": 2048, "flags": { "isOptional": true }, - "type": { - "type": "reference", - "target": 854, - "name": "ApplicationMethodAllocationValues", - "package": "@medusajs/types" - } - }, - { - "id": 856, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 861, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 862, - "name": "promotion", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { + "signatures": [ + { + "id": 1293, + "name": "__joinerConfig", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { "type": "reference", - "target": 888, - "name": "PromotionDTO", + "target": 1219, + "name": "ModuleJoinerConfig", "package": "@medusajs/types" } - ] - } - }, - { - "id": 863, - "name": "target_rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 914, - "name": "PromotionRuleDTO", - "package": "@medusajs/types" } - } - }, - { - "id": 858, - "name": "target_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 853, - "name": "ApplicationMethodTargetTypeValues", - "package": "@medusajs/types" - } - }, - { - "id": 857, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 852, - "name": "ApplicationMethodTypeValues", - "package": "@medusajs/types" - } - }, - { - "id": 860, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 859, - 856, - 861, - 862, - 863, - 858, - 857, - 860 ] - } - ] - }, - { - "id": 864, - "name": "CreateApplicationMethodDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 867, - "name": "allocation", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 854, - "name": "ApplicationMethodAllocationValues", - "package": "@medusajs/types" - } }, { - "id": 869, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 870, - "name": "promotion", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 888, - "name": "PromotionDTO", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 871, - "name": "target_rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 916, - "name": "CreatePromotionRuleDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 866, - "name": "target_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 853, - "name": "ApplicationMethodTargetTypeValues", - "package": "@medusajs/types" - } - }, - { - "id": 865, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 852, - "name": "ApplicationMethodTypeValues", - "package": "@medusajs/types" - } - }, - { - "id": 868, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 867, - 869, - 870, - 871, - 866, - 865, - 868 - ] - } - ] - }, - { - "id": 894, - "name": "CreatePromotionDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 898, - "name": "application_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 864, - "name": "CreateApplicationMethodDTO", - "package": "@medusajs/types" - } - }, - { - "id": 895, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 897, - "name": "is_automatic", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 899, - "name": "rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 916, - "name": "CreatePromotionRuleDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 896, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 887, - "name": "PromotionType", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 898, - 895, - 897, - 899, - 896 - ] - } - ] - }, - { - "id": 916, - "name": "CreatePromotionRuleDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 918, - "name": "attribute", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 917, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 919, - "name": "operator", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 913, - "name": "PromotionRuleOperatorValues", - "package": "@medusajs/types" - } - }, - { - "id": 920, - "name": "values", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 918, - 917, - 919, - 920 - ] - } - ] - }, - { - "id": 931, - "name": "CreatePromotionRuleValueDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 933, - "name": "promotion_rule", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 914, - "name": "PromotionRuleDTO", - "package": "@medusajs/types" - } - }, - { - "id": 932, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 933, - 932 - ] - } - ] - }, - { - "id": 880, - "name": "FilterableApplicationMethodProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object used to allow specifying flexible queries with and/or conditions." - } - ] - }, - "children": [ - { - "id": 885, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 880, - "name": "FilterableApplicationMethodProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 880, - "name": "FilterableApplicationMethodProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 886, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 880, - "name": "FilterableApplicationMethodProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 880, - "name": "FilterableApplicationMethodProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 884, - "name": "allocation", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 854, - "name": "ApplicationMethodAllocationValues", - "package": "@medusajs/types" - } - } - }, - { - "id": 881, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 883, - "name": "target_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 853, - "name": "ApplicationMethodTargetTypeValues", - "package": "@medusajs/types" - } - } - }, - { - "id": 882, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 852, - "name": "ApplicationMethodTypeValues", - "package": "@medusajs/types" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 885, - 886, - 884, - 881, - 883, - 882 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 880, - "name": "FilterableApplicationMethodProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 906, - "name": "FilterablePromotionProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object used to allow specifying flexible queries with and/or conditions." - } - ] - }, - "children": [ - { - "id": 911, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 906, - "name": "FilterablePromotionProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 906, - "name": "FilterablePromotionProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 912, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 906, - "name": "FilterablePromotionProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 906, - "name": "FilterablePromotionProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 908, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 907, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 909, - "name": "is_automatic", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 910, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 887, - "name": "PromotionType", - "package": "@medusajs/types" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 911, - 912, - 908, - 907, - 909, - 910 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 906, - "name": "FilterablePromotionProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 925, - "name": "FilterablePromotionRuleProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object used to allow specifying flexible queries with and/or conditions." - } - ] - }, - "children": [ - { - "id": 927, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 925, - "name": "FilterablePromotionRuleProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 925, - "name": "FilterablePromotionRuleProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 928, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 925, - "name": "FilterablePromotionRuleProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 925, - "name": "FilterablePromotionRuleProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 926, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 927, - 928, - 926 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 925, - "name": "FilterablePromotionRuleProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 936, - "name": "FilterablePromotionRuleValueProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object used to allow specifying flexible queries with and/or conditions." - } - ] - }, - "children": [ - { - "id": 938, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 936, - "name": "FilterablePromotionRuleValueProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 936, - "name": "FilterablePromotionRuleValueProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 939, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 936, - "name": "FilterablePromotionRuleValueProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 936, - "name": "FilterablePromotionRuleValueProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 937, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 938, - 939, - 937 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 936, - "name": "FilterablePromotionRuleValueProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 940, - "name": "IPromotionModuleService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 985, + "id": 1294, "name": "__hooks", "variant": "declaration", "kind": 1024, @@ -14101,14 +30147,14 @@ "type": { "type": "reflection", "declaration": { - "id": 986, + "id": 1295, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 987, + "id": 1296, "name": "onApplicationStart", "variant": "declaration", "kind": 1024, @@ -14118,14 +30164,14 @@ "type": { "type": "reflection", "declaration": { - "id": 988, + "id": 1297, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 989, + "id": 1298, "name": "__type", "variant": "signature", "kind": 4096, @@ -14155,5049 +30201,198 @@ { "title": "Properties", "children": [ - 987 + 1296 ] } ] } - }, - "inheritedFrom": { - "type": "reference", - "target": 846, - "name": "IModuleService.__hooks" } - }, - { - "id": 983, - "name": "__joinerConfig", - "variant": "declaration", - "kind": 2048, - "flags": { - "isOptional": true - }, - "signatures": [ - { - "id": 984, - "name": "__joinerConfig", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": 771, - "name": "ModuleJoinerConfig", - "package": "@medusajs/types" - }, - "inheritedFrom": { - "type": "reference", - "target": 845, - "name": "IModuleService.__joinerConfig" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 844, - "name": "IModuleService.__joinerConfig" - } - }, - { - "id": 963, - "name": "addPromotionRules", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 964, - "name": "addPromotionRules", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 965, - "name": "promotionId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 966, - "name": "rulesData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 916, - "name": "CreatePromotionRuleDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 967, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 888, - "name": "PromotionDTO", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 968, - "name": "addPromotionTargetRules", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 969, - "name": "addPromotionTargetRules", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 970, - "name": "promotionId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 971, - "name": "rulesData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 916, - "name": "CreatePromotionRuleDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 972, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 888, - "name": "PromotionDTO", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 941, - "name": "create", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 942, - "name": "create", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 943, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 894, - "name": "CreatePromotionDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 944, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 888, - "name": "PromotionDTO", - "package": "@medusajs/types" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 959, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 960, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 961, - "name": "ids", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 962, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 949, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 950, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 951, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 906, - "name": "FilterablePromotionProps", - "package": "@medusajs/types" - } - }, - { - "id": 952, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 221, - "typeArguments": [ - { - "type": "reference", - "target": 888, - "name": "PromotionDTO", - "package": "@medusajs/types" - } - ], - "name": "FindConfig", - "package": "@medusajs/types" - } - }, - { - "id": 953, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 888, - "name": "PromotionDTO", - "package": "@medusajs/types" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 973, - "name": "removePromotionRules", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 974, - "name": "removePromotionRules", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 975, - "name": "promotionId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 976, - "name": "rulesData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 923, - "name": "RemovePromotionRuleDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 977, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 888, - "name": "PromotionDTO", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 978, - "name": "removePromotionTargetRules", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 979, - "name": "removePromotionTargetRules", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 980, - "name": "promotionId", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 981, - "name": "rulesData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 923, - "name": "RemovePromotionRuleDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 982, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 888, - "name": "PromotionDTO", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 954, - "name": "retrieve", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 955, - "name": "retrieve", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 956, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 957, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 221, - "typeArguments": [ - { - "type": "reference", - "target": 888, - "name": "PromotionDTO", - "package": "@medusajs/types" - } - ], - "name": "FindConfig", - "package": "@medusajs/types" - } - }, - { - "id": 958, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 888, - "name": "PromotionDTO", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 945, - "name": "update", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 946, - "name": "update", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 947, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 900, - "name": "UpdatePromotionDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 948, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 888, - "name": "PromotionDTO", - "package": "@medusajs/types" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] } ], "groups": [ { "title": "Properties", "children": [ - 985 + 1294 ] }, { "title": "Methods", "children": [ - 983, - 963, - 968, - 941, - 959, - 949, - 973, - 978, - 954, - 945 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 843, - "name": "IModuleService", - "package": "@medusajs/types" - } - ] - }, - { - "id": 888, - "name": "PromotionDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 893, - "name": "application_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 855, - "name": "ApplicationMethodDTO", - "package": "@medusajs/types" - } - }, - { - "id": 890, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 889, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 892, - "name": "is_automatic", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 891, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 887, - "name": "PromotionType", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 893, - 890, - 889, - 892, - 891 - ] - } - ] - }, - { - "id": 914, - "name": "PromotionRuleDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 915, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 915 - ] - } - ] - }, - { - "id": 929, - "name": "PromotionRuleValueDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 930, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 930 - ] - } - ] - }, - { - "id": 923, - "name": "RemovePromotionRuleDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 924, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 924 - ] - } - ] - }, - { - "id": 872, - "name": "UpdateApplicationMethodDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 876, - "name": "allocation", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 854, - "name": "ApplicationMethodAllocationValues", - "package": "@medusajs/types" - } - }, - { - "id": 873, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 878, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 879, - "name": "promotion", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 888, - "name": "PromotionDTO", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 875, - "name": "target_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 853, - "name": "ApplicationMethodTargetTypeValues", - "package": "@medusajs/types" - } - }, - { - "id": 874, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 852, - "name": "ApplicationMethodTypeValues", - "package": "@medusajs/types" - } - }, - { - "id": 877, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 876, - 873, - 878, - 879, - 875, - 874, - 877 - ] - } - ] - }, - { - "id": 900, - "name": "UpdatePromotionDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 905, - "name": "application_method", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 872, - "name": "UpdateApplicationMethodDTO", - "package": "@medusajs/types" - } - }, - { - "id": 903, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 901, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 902, - "name": "is_automatic", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 904, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 887, - "name": "PromotionType", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 905, - 903, - 901, - 902, - 904 - ] - } - ] - }, - { - "id": 921, - "name": "UpdatePromotionRuleDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 922, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 922 - ] - } - ] - }, - { - "id": 934, - "name": "UpdatePromotionRuleValueDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 935, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 935 - ] - } - ] - }, - { - "id": 854, - "name": "ApplicationMethodAllocationValues", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "each" - }, - { - "type": "literal", - "value": "across" - } - ] - } - }, - { - "id": 853, - "name": "ApplicationMethodTargetTypeValues", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "order" - }, - { - "type": "literal", - "value": "shipping" - }, - { - "type": "literal", - "value": "item" - } - ] - } - }, - { - "id": 852, - "name": "ApplicationMethodTypeValues", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "fixed" - }, - { - "type": "literal", - "value": "percentage" - } - ] - } - }, - { - "id": 913, - "name": "PromotionRuleOperatorValues", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "gt" - }, - { - "type": "literal", - "value": "lt" - }, - { - "type": "literal", - "value": "eq" - }, - { - "type": "literal", - "value": "ne" - }, - { - "type": "literal", - "value": "in" - }, - { - "type": "literal", - "value": "lte" - }, - { - "type": "literal", - "value": "gte" - } - ] - } - }, - { - "id": 887, - "name": "PromotionType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "standard" - }, - { - "type": "literal", - "value": "buyget" - } - ] - } - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [ - 855, - 864, - 894, - 916, - 931, - 880, - 906, - 925, - 936, - 940, - 888, - 914, - 929, - 923, - 872, - 900, - 921, - 934 - ] - }, - { - "title": "Type Aliases", - "children": [ - 854, - 853, - 852, - 913, - 887 - ] - } - ] - }, - { - "id": 990, - "name": "RegionTypes", - "variant": "declaration", - "kind": 4, - "flags": {}, - "children": [ - { - "id": 991, - "name": "RegionDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 992, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 998, - "name": "automatic_taxes", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 994, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 997, - "name": "gift_cards_taxable", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1001, - "name": "includes_tax", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1000, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 993, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 996, - "name": "tax_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 999, - "name": "tax_provider_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 995, - "name": "tax_rate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 998, - 994, - 997, - 1001, - 1000, - 993, - 996, - 999, - 995 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Type Aliases", - "children": [ - 991 - ] - } - ] - }, - { - "id": 1002, - "name": "SalesChannelTypes", - "variant": "declaration", - "kind": 4, - "flags": {}, - "children": [ - { - "id": 1007, - "name": "SalesChannelDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1009, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1008, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1010, - "name": "is_disabled", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1012, - "name": "locations", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1003, - "name": "SalesChannelLocationDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 1011, - "name": "metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1009, - 1008, - 1010, - 1012, - 1011 - ] - } - ] - }, - { - "id": 1003, - "name": "SalesChannelLocationDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1005, - "name": "location_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1006, - "name": "sales_channel", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 1007, - "name": "SalesChannelDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1004, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1005, - 1006, - 1004 - ] - } - ] - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [ - 1007, - 1003 - ] - } - ] - }, - { - "id": 1013, - "name": "SearchTypes", - "variant": "declaration", - "kind": 4, - "flags": {}, - "children": [ - { - "id": 1022, - "name": "ISearchService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1023, - "name": "options", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1031, - "name": "addDocuments", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1032, - "name": "addDocuments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to index documents by the search engine provider" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "returns response from search engine provider" - } - ] - } - ] - }, - "parameters": [ - { - "id": 1033, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the index name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1034, - "name": "documents", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "documents array to be indexed" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1035, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "of documents to be added (e.g: products, regions, orders, etc)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - }, - { - "id": 1024, - "name": "createIndex", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1025, - "name": "createIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to create an index" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "returns response from search engine provider" - } - ] - } - ] - }, - "parameters": [ - { - "id": 1026, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the index name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1027, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the options" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - }, - { - "id": 1045, - "name": "deleteAllDocuments", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1046, - "name": "deleteAllDocuments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to delete all documents" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "returns response from search engine provider" - } - ] - } - ] - }, - "parameters": [ - { - "id": 1047, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the index name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - }, - { - "id": 1041, - "name": "deleteDocument", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1042, - "name": "deleteDocument", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to delete document" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "returns response from search engine provider" - } - ] - } - ] - }, - "parameters": [ - { - "id": 1043, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the index name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1044, - "name": "document_id", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the id of the document" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - }, - { - "id": 1028, - "name": "getIndex", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1029, - "name": "getIndex", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to get an index" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "returns response from search engine provider" - } - ] - } - ] - }, - "parameters": [ - { - "id": 1030, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the index name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - }, - { - "id": 1036, - "name": "replaceDocuments", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1037, - "name": "replaceDocuments", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to replace documents" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "returns response from search engine provider" - } - ] - } - ] - }, - "parameters": [ - { - "id": 1038, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the index name." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1039, - "name": "documents", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "array of document objects that will replace existing documents" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1040, - "name": "type", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "type of documents to be replaced (e.g: products, regions, orders, etc)" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - }, - { - "id": 1048, - "name": "search", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1049, - "name": "search", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to search for a document in an index" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "returns response from search engine provider" - } - ] - } - ] - }, - "parameters": [ - { - "id": 1050, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the index name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1051, - "name": "query", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the search query" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1052, - "name": "options", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "any options passed to the request object other than the query and indexName\n- additionalOptions contain any provider specific options" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - }, - { - "id": 1053, - "name": "updateSettings", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1054, - "name": "updateSettings", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Used to update the settings of an index" - } - ], - "blockTags": [ - { - "tag": "@returns", - "content": [ - { - "kind": "text", - "text": "returns response from search engine provider" - } - ] - } - ] - }, - "parameters": [ - { - "id": 1055, - "name": "indexName", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the index name" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1056, - "name": "settings", - "variant": "param", - "kind": 32768, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "settings object" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1023 - ] - }, - { - "title": "Methods", - "children": [ - 1031, - 1024, - 1045, - 1041, - 1028, - 1036, - 1048, - 1053 - ] - } - ] - }, - { - "id": 1014, - "name": "IndexSettings", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1015, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1016, - "name": "indexSettings", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Settings specific to the provider. E.g. " - }, - { - "kind": "code", - "text": "`searchableAttributes`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1017, - "name": "primaryKey", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Primary key for the index. Used to enforce unique documents in an index. See more in Meilisearch' https://docs.meilisearch.com/learn/core_concepts/primary_key.html." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1018, - "name": "transformer", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Document transformer. Used to transform documents before they are added to the index." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1019, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 1020, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Document transformer. Used to transform documents before they are added to the index." - } - ] - }, - "parameters": [ - { - "id": 1021, - "name": "document", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "intrinsic", - "name": "any" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1016, - 1017, - 1018 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [ - 1022 - ] - }, - { - "title": "Type Aliases", - "children": [ - 1014 - ] - } - ] - }, - { - "id": 1057, - "name": "TransactionBaseTypes", - "variant": "declaration", - "kind": 4, - "flags": {}, - "children": [ - { - "id": 1058, - "name": "ITransactionBaseService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1059, - "name": "withTransaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1060, - "name": "withTransaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1061, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "type": { - "type": "intrinsic", - "name": "this" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [ - 1059 + 1292 ] } ], "extendedBy": [ { "type": "reference", - "target": 567, - "name": "IEventBusService" + "target": 16, + "name": "IAuthenticationModuleService" + }, + { + "type": "reference", + "target": 554, + "name": "ICartModuleService" + }, + { + "type": "reference", + "target": 1494, + "name": "IPromotionModuleService" + }, + { + "type": "reference", + "target": 2234, + "name": "IPaymentModuleService" } ] } ], "groups": [ + { + "title": "Enumerations", + "children": [ + 1140, + 1143 + ] + }, { "title": "Interfaces", "children": [ - 1058 + 1264, + 1291 + ] + }, + { + "title": "Type Aliases", + "children": [ + 1133, + 1138, + 1139, + 1146, + 1156, + 1168, + 1176, + 1188, + 1195, + 1200, + 1204, + 1210, + 1215, + 1219, + 1246, + 1250, + 1278, + 1285, + 1286 ] } ] }, { - "id": 1062, - "name": "WorkflowTypes", + "id": 2316, + "name": "ModuleDeclaration", "variant": "declaration", - "kind": 4, + "kind": 2097152, "flags": {}, - "children": [ - { - "id": 1063, - "name": "CartWorkflow", - "variant": "declaration", - "kind": 4, - "flags": {}, - "children": [ - { - "id": 1067, - "name": "CreateCartWorkflowInputDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1075, - "name": "billing_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1, - "name": "AddressDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1074, - "name": "billing_address_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1071, - "name": "context", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "object" - } - }, - { - "id": 1069, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1077, - "name": "customer_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1078, - "name": "email", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1070, - "name": "items", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1064, - "name": "CreateLineItemInputDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 1068, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1072, - "name": "sales_channel_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1076, - "name": "shipping_address", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1, - "name": "AddressDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1073, - "name": "shipping_address_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1075, - 1074, - 1071, - 1069, - 1077, - 1078, - 1070, - 1068, - 1072, - 1076, - 1073 - ] - } - ] - }, - { - "id": 1064, - "name": "CreateLineItemInputDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1066, - "name": "quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1065, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1066, - 1065 - ] - } - ] - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [ - 1067, - 1064 - ] - } - ] - }, - { - "id": 1079, - "name": "CommonWorkflow", - "variant": "declaration", - "kind": 4, - "flags": {}, - "children": [ - { - "id": 1080, - "name": "WorkflowInputConfig", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1081, - "name": "listConfig", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1082, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1084, - "name": "relations", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1083, - "name": "select", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1084, - 1083 - ] - } - ] - } - } - }, - { - "id": 1085, - "name": "retrieveConfig", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1086, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1088, - "name": "relations", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1087, - "name": "select", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1088, - 1087 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1081, - 1085 - ] - } - ] - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [ - 1080 - ] - } - ] - }, - { - "id": 1089, - "name": "PriceListWorkflow", - "variant": "declaration", - "kind": 4, - "flags": {}, - "children": [ - { - "id": 1090, - "name": "CreatePriceListDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1103, - "name": "customer_groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1104, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1105, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1105 - ] - } - ] - } - } - } - }, - { - "id": 1092, - "name": "ends_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1096, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1097, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1098, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1099, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1101, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1102, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1100, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1098, - 1099, - 1101, - 1102, - 1100 - ] - } - ] - } - } - } - }, - { - "id": 1095, - "name": "rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1607, - "name": "PriceListRuleDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 1094, - "name": "rules_count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1091, - "name": "starts_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1093, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1538, - "name": "PriceListStatus", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1103, - 1092, - 1096, - 1095, - 1094, - 1091, - 1093 - ] - } - ] - }, - { - "id": 1109, - "name": "CreatePriceListPriceDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1110, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1111, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1114, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1115, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1112, - "name": "price_set_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1113, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1110, - 1111, - 1114, - 1115, - 1112, - 1113 - ] - } - ] - }, - { - "id": 1106, - "name": "CreatePriceListRuleDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1107, - "name": "rule_attribute", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1108, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1107, - 1108 - ] - } - ] - }, - { - "id": 1127, - "name": "CreatePriceListWorkflowDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1130, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1133, - "name": "ends_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1129, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1136, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1721, - "name": "InputPrice", - "package": "@medusajs/types" - } - } - }, - { - "id": 1137, - "name": "rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1566, - "name": "CreatePriceListRules", - "package": "@medusajs/types" - } - }, - { - "id": 1135, - "name": "rules_count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1132, - "name": "starts_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1134, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1538, - "name": "PriceListStatus", - "package": "@medusajs/types" - } - }, - { - "id": 1128, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1131, - "name": "type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1130, - 1133, - 1129, - 1136, - 1137, - 1135, - 1132, - 1134, - 1128, - 1131 - ] - } - ] - }, - { - "id": 1116, - "name": "CreatePriceListWorkflowInputDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1117, - "name": "price_lists", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1127, - "name": "CreatePriceListWorkflowDTO", - "package": "@medusajs/types" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1117 - ] - } - ] - }, - { - "id": 1124, - "name": "RemovePriceListPricesWorkflowInputDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1125, - "name": "money_amount_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1126, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1125, - 1126 - ] - } - ] - }, - { - "id": 1118, - "name": "RemovePriceListProductsWorkflowInputDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1120, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1119, - "name": "product_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1120, - 1119 - ] - } - ] - }, - { - "id": 1121, - "name": "RemovePriceListVariantsWorkflowInputDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1123, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1122, - "name": "variant_ids", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1123, - 1122 - ] - } - ] - }, - { - "id": 1155, - "name": "RemovePriceListWorkflowInputDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1156, - "name": "price_lists", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1156 - ] - } - ] - }, - { - "id": 1142, - "name": "UpdatePriceListWorkflowDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1150, - "name": "customer_groups", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1151, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1152, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1152 - ] - } - ] - } - } - } - }, - { - "id": 1146, - "name": "ends_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1143, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1144, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1149, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1138, - "name": "PriceListVariantPriceDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 1148, - "name": "rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1566, - "name": "CreatePriceListRules", - "package": "@medusajs/types" - } - }, - { - "id": 1145, - "name": "starts_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1147, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1538, - "name": "PriceListStatus", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1150, - 1146, - 1143, - 1144, - 1149, - 1148, - 1145, - 1147 - ] - } - ] - }, - { - "id": 1153, - "name": "UpdatePriceListWorkflowInputDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1154, - "name": "price_lists", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1142, - "name": "UpdatePriceListWorkflowDTO", - "package": "@medusajs/types" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1154 - ] - } - ] - }, - { - "id": 1138, - "name": "PriceListVariantPriceDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "intersection", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/workflow/product/update-products.ts", - "qualifiedName": "UpdateProductVariantPricesInputDTO" - }, - "name": "UpdateProductVariantPricesInputDTO", - "package": "@medusajs/types" - }, - { - "type": "reflection", - "declaration": { - "id": 1139, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1141, - "name": "price_set_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1140, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1141, - 1140 - ] - } - ] - } - } - ] - } - } - ], - "groups": [ - { - "title": "Interfaces", - "children": [ - 1090, - 1109, - 1106, - 1127, - 1116, - 1124, - 1118, - 1121, - 1155, - 1142, - 1153 - ] - }, - { - "title": "Type Aliases", - "children": [ - 1138 - ] - } - ] - } - ], - "groups": [ - { - "title": "Namespaces", - "children": [ - 1063, - 1079, - 1089 - ] - } - ] - }, - { - "id": 1538, - "name": "PriceListStatus", - "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [ + "type": { + "type": "union", + "types": [ { - "kind": "text", - "text": "The price list's status." + "type": "reference", + "target": 1156, + "name": "ExternalModuleDeclaration", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 1146, + "name": "InternalModuleDeclaration", + "package": "@medusajs/types" } ] - }, - "children": [ - { - "id": 1539, - "name": "ACTIVE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list is enabled and its prices can be used." - } - ] - }, - "type": { - "type": "literal", - "value": "active" - } - }, - { - "id": 1540, - "name": "DRAFT", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list is disabled, meaning its prices can't be used yet." - } - ] - }, - "type": { - "type": "literal", - "value": "draft" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 1539, - 1540 - ] - } - ] + } }, { - "id": 1541, - "name": "PriceListType", + "id": 2234, + "name": "IPaymentModuleService", "variant": "declaration", - "kind": 8, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list's type." - } - ] - }, - "children": [ - { - "id": 1543, - "name": "OVERRIDE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list's prices override original prices. This affects the calculated price of associated price sets." - } - ] - }, - "type": { - "type": "literal", - "value": "override" - } - }, - { - "id": 1542, - "name": "SALE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list's prices are used for a sale." - } - ] - }, - "type": { - "type": "literal", - "value": "sale" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 1543, - 1542 - ] - } - ] - }, - { - "id": 133, - "name": "ProviderDomain", - "variant": "declaration", - "kind": 8, + "kind": 256, "flags": {}, "children": [ { - "id": 136, - "name": "ADMIN", + "id": 2235, + "name": "__joinerConfig", "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "admin" - } - }, - { - "id": 134, - "name": "ALL", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "all" - } - }, - { - "id": 135, - "name": "STORE", - "variant": "declaration", - "kind": 16, - "flags": {}, - "type": { - "type": "literal", - "value": "store" - } - } - ], - "groups": [ - { - "title": "Enumeration Members", - "children": [ - 136, - 134, - 135 - ] - } - ] - }, - { - "id": 144, - "name": "AbstractAuthenticationModuleProvider", - "variant": "declaration", - "kind": 128, - "flags": { - "isAbstract": true - }, - "children": [ - { - "id": 147, - "name": "constructor", - "variant": "declaration", - "kind": 512, - "flags": {}, + "kind": 2048, + "flags": { + "isOptional": true + }, "signatures": [ { - "id": 148, - "name": "new AbstractAuthenticationModuleProvider", + "id": 2236, + "name": "__joinerConfig", "variant": "signature", - "kind": 16384, + "kind": 4096, "flags": {}, "type": { "type": "reference", - "target": 144, - "name": "AbstractAuthenticationModuleProvider", + "target": 1219, + "name": "ModuleJoinerConfig", "package": "@medusajs/types" + }, + "inheritedFrom": { + "type": "reference", + "target": 1293, + "name": "IModuleService.__joinerConfig" } } - ] + ], + "inheritedFrom": { + "type": "reference", + "target": 1292, + "name": "IModuleService.__joinerConfig" + } }, { - "id": 146, - "name": "DISPLAY_NAME", + "id": 2237, + "name": "__hooks", "variant": "declaration", "kind": 1024, "flags": { - "isPublic": true, - "isStatic": true + "isOptional": true }, "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 145, - "name": "PROVIDER", - "variant": "declaration", - "kind": 1024, - "flags": { - "isPublic": true, - "isStatic": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 149, - "name": "authenticate", - "variant": "declaration", - "kind": 2048, - "flags": { - "isAbstract": true - }, - "signatures": [ - { - "id": 150, - "name": "authenticate", - "variant": "signature", - "kind": 4096, + "type": "reflection", + "declaration": { + "id": 2238, + "name": "__type", + "variant": "declaration", + "kind": 65536, "flags": {}, - "parameters": [ + "children": [ { - "id": 151, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Constructors", - "children": [ - 147 - ] - }, - { - "title": "Properties", - "children": [ - 146, - 145 - ] - }, - { - "title": "Methods", - "children": [ - 149 - ] - } - ] - }, - { - "id": 1636, - "name": "AddPriceListPricesDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prices to be added to a price list." - } - ] - }, - "children": [ - { - "id": 1637, - "name": "priceListId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the price list to add prices to." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1638, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prices to add." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1556, - "name": "PriceListPriceDTO", - "package": "@medusajs/types" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1637, - 1638 - ] - } - ] - }, - { - "id": 1432, - "name": "AddPricesDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prices to add to a price set." - } - ] - }, - "children": [ - { - "id": 1433, - "name": "priceSetId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the price set to add prices to." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1434, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prices to add to the price set." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1424, - "name": "CreatePricesDTO", - "package": "@medusajs/types" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1433, - 1434 - ] - } - ] - }, - { - "id": 1419, - "name": "AddRulesDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The rules to add to a price set." - } - ] - }, - "children": [ - { - "id": 1420, - "name": "priceSetId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the price set to add the rules to." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1421, - "name": "rules", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The rules to add to a price set." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1422, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1423, - "name": "attribute", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the rule's " - }, - { - "kind": "code", - "text": "`rule_attribute`" - }, - { - "kind": "text", - "text": " attribute." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1423 - ] - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1420, - 1421 - ] - } - ] - }, - { - "id": 1695, - "name": "BaseRepositoryService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Data access layer (DAL) interface to implements for any repository service.\nThis layer helps to separate the business logic (service layer) from accessing the\nORM directly and allows to switch to another ORM without changing the business logic." - } - ] - }, - "children": [ - { - "id": 1711, - "name": "getActiveManager", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1712, - "name": "getActiveManager", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 1713, - "name": "TManager", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 483, - "name": "TManager", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - ] - }, - { - "id": 1708, - "name": "getFreshManager", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1709, - "name": "getFreshManager", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 1710, - "name": "TManager", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "type": { - "type": "reference", - "target": 480, - "name": "TManager", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - ] - }, - { - "id": 1714, - "name": "serialize", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1715, - "name": "serialize", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 1716, - "name": "TOutput", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "object" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "object" - } - } - ] - } - } - ], - "parameters": [ - { - "id": 1717, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "any" - } - }, - { - "id": 1718, - "name": "options", - "variant": "param", - "kind": 32768, + "id": 2239, + "name": "onApplicationStart", + "variant": "declaration", + "kind": 1024, "flags": { "isOptional": true }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 486, - "name": "TOutput", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1696, - "name": "transaction", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1697, - "name": "transaction", - "variant": "signature", - "kind": 4096, - "flags": {}, - "typeParameter": [ - { - "id": 1698, - "name": "TManager", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "parameters": [ - { - "id": 1699, - "name": "task", - "variant": "param", - "kind": 32768, - "flags": {}, "type": { "type": "reflection", "declaration": { - "id": 1700, + "id": 2240, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "signatures": [ { - "id": 1701, + "id": 2241, "name": "__type", "variant": "signature", "kind": 4096, "flags": {}, - "parameters": [ - { - "id": 1702, - "name": "transactionManager", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 468, - "name": "TManager", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - ], "type": { "type": "reference", "target": { @@ -19207,7 +30402,7 @@ "typeArguments": [ { "type": "intrinsic", - "name": "any" + "name": "void" } ], "name": "Promise", @@ -19217,140 +30412,51 @@ ] } } - }, - { - "id": 1703, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1704, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1707, - "name": "enableNestedTransactions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1705, - "name": "isolationLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1706, - "name": "transaction", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 468, - "name": "TManager", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1707, - 1705, - 1706 - ] - } - ] - } - } } ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } + "groups": [ + { + "title": "Properties", + "children": [ + 2239 + ] + } + ] } - ] + }, + "inheritedFrom": { + "type": "reference", + "target": 1294, + "name": "IModuleService.__hooks" + } } ], "groups": [ + { + "title": "Properties", + "children": [ + 2237 + ] + }, { "title": "Methods", "children": [ - 1711, - 1708, - 1714, - 1696 + 2235 ] } ], - "typeParameters": [ - { - "id": 1719, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - } - ], - "extendedBy": [ + "extendedTypes": [ { "type": "reference", - "target": 437, - "name": "RepositoryService" - }, - { - "type": "reference", - "target": 490, - "name": "TreeRepositoryService" + "target": 1291, + "name": "IModuleService", + "package": "@medusajs/types" } ] }, { - "id": 1398, - "name": "CalculatedPriceSet", + "id": 1879, + "name": "CurrencyDTO", "variant": "declaration", "kind": 256, "flags": {}, @@ -19358,1119 +30464,13 @@ "summary": [ { "kind": "text", - "text": "The calculated price for a specific price set and context." + "text": "A currency's data." } ] }, "children": [ { - "id": 1401, - "name": "calculated_amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount of the calculated price, or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " if there isn't a calculated price." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1405, - "name": "calculated_price", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the calculated price." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1406, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1411, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`max_quantity`" - }, - { - "kind": "text", - "text": " field defined on a money amount." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1410, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`min_quantity`" - }, - { - "kind": "text", - "text": " field defined on a money amount." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1407, - "name": "money_amount_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the money amount selected as the calculated price." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1408, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated price list, if any." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1409, - "name": "price_list_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the associated price list, if any." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1411, - 1410, - 1407, - 1408, - 1409 - ] - } - ] - } - } - }, - { - "id": 1404, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The currency code of the calculated price, or null if there isn't a calculated price." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1399, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the price set." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1400, - "name": "is_calculated_price_price_list", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found,\nthe calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is " - }, - { - "kind": "code", - "text": "`false`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1402, - "name": "is_original_price_price_list", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Whether the original price is associated with a price list. During the calculation process, if the price list of the calculated price is of type override,\nthe original price will be the same as the calculated price. In that case, the value of this property is " - }, - { - "kind": "code", - "text": "`true`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1403, - "name": "original_amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount of the original price, or " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " if there isn't a calculated price." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1412, - "name": "original_price", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the original price." - } - ] - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1413, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1418, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`max_quantity`" - }, - { - "kind": "text", - "text": " field defined on a money amount." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1417, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The " - }, - { - "kind": "code", - "text": "`min_quantity`" - }, - { - "kind": "text", - "text": " field defined on a money amount." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - }, - { - "id": 1414, - "name": "money_amount_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the money amount selected as the original price." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1415, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated price list, if any." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1416, - "name": "price_list_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the associated price list, if any." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1418, - 1417, - 1414, - 1415, - 1416 - ] - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1401, - 1405, - 1404, - 1399, - 1400, - 1402, - 1403, - 1412 - ] - } - ] - }, - { - "id": 1389, - "name": "CalculatedPriceSetDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A calculated price set's data." - } - ] - }, - "children": [ - { - "id": 1392, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The calculated amount. It can possibly be " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": " if there's no price set up for the provided context." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1393, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The currency code of the calculated price. It can possibly be " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1390, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1395, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum quantity required to be purchased for this price to apply. It's set if the " - }, - { - "kind": "code", - "text": "`quantity`" - }, - { - "kind": "text", - "text": " property is provided in the context. Otherwise, its value will be " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1394, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The minimum quantity required to be purchased for this price to apply. It's set if the " - }, - { - "kind": "code", - "text": "`quantity`" - }, - { - "kind": "text", - "text": " property is provided in the context. Otherwise, its value will be " - }, - { - "kind": "code", - "text": "`null`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1397, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated price list, if any." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1396, - "name": "price_list_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The type of the associated price list, if any." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1391, - "name": "price_set_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated price set." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1392, - 1393, - 1390, - 1395, - 1394, - 1397, - 1396, - 1391 - ] - } - ] - }, - { - "id": 1650, - "name": "Context", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A shared context object that is used to share resources between the application and the module." - } - ] - }, - "children": [ - { - "id": 1654, - "name": "enableNestedTransactions", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A boolean value indicating whether nested transactions are enabled." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1653, - "name": "isolationLevel", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A string indicating the isolation level of the context. Possible values are " - }, - { - "kind": "code", - "text": "`READ UNCOMMITTED`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`READ COMMITTED`" - }, - { - "kind": "text", - "text": ", " - }, - { - "kind": "code", - "text": "`REPEATABLE READ`" - }, - { - "kind": "text", - "text": ", or " - }, - { - "kind": "code", - "text": "`SERIALIZABLE`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1652, - "name": "manager", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An instance of a manager, typically an entity manager, of type " - }, - { - "kind": "code", - "text": "`TManager`" - }, - { - "kind": "text", - "text": ", which is a typed parameter passed to the context to specify the type of the " - }, - { - "kind": "code", - "text": "`manager`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "reference", - "target": 1656, - "name": "TManager", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - }, - { - "id": 1655, - "name": "transactionId", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A string indicating the ID of the current transaction." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1651, - "name": "transactionManager", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An instance of a transaction manager of type " - }, - { - "kind": "code", - "text": "`TManager`" - }, - { - "kind": "text", - "text": ", which is a typed parameter passed to the context to specify the type of the " - }, - { - "kind": "code", - "text": "`transactionManager`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "reference", - "target": 1656, - "name": "TManager", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1654, - 1653, - 1652, - 1655, - 1651 - ] - } - ], - "typeParameters": [ - { - "id": 1656, - "name": "TManager", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "unknown" - } - } - ] - }, - { - "id": 1295, - "name": "CreateCurrencyDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A currency to create." - } - ] - }, - "children": [ - { - "id": 1296, + "id": 1880, "name": "code", "variant": "declaration", "kind": 1024, @@ -20489,11 +30489,55 @@ } }, { - "id": 1299, + "id": 1881, + "name": "symbol", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The symbol of the currency." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1882, + "name": "symbol_native", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1883, "name": "name", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { @@ -20506,9 +30550,56 @@ "type": "intrinsic", "name": "string" } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1880, + 1881, + 1882, + 1883 + ] + } + ] + }, + { + "id": 1884, + "name": "CreateCurrencyDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A currency to create." + } + ] + }, + "children": [ + { + "id": 1885, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the currency." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } }, { - "id": 1297, + "id": 1886, "name": "symbol", "variant": "declaration", "kind": 1024, @@ -20527,7 +30618,7 @@ } }, { - "id": 1298, + "id": 1887, "name": "symbol_native", "variant": "declaration", "kind": 1024, @@ -20544,38 +30635,10 @@ "type": "intrinsic", "name": "string" } - } - ], - "groups": [ + }, { - "title": "Properties", - "children": [ - 1296, - 1299, - 1297, - 1298 - ] - } - ] - }, - { - "id": 1320, - "name": "CreateMoneyAmountDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The money amount to create." - } - ] - }, - "children": [ - { - "id": 1324, - "name": "amount", + "id": 1888, + "name": "name", "variant": "declaration", "kind": 1024, "flags": {}, @@ -20583,18 +30646,73 @@ "summary": [ { "kind": "text", - "text": "The amount of this money amount." + "text": "The name of the currency." } ] }, "type": { "type": "intrinsic", - "name": "number" + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1885, + 1886, + 1887, + 1888 + ] + } + ] + }, + { + "id": 1889, + "name": "UpdateCurrencyDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to update in a currency. The " + }, + { + "kind": "code", + "text": "`code`" + }, + { + "kind": "text", + "text": " is used to identify which currency to update." + } + ] + }, + "children": [ + { + "id": 1890, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The code of the currency to update." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" } }, { - "id": 1323, - "name": "currency", + "id": 1891, + "name": "symbol", "variant": "declaration", "kind": 1024, "flags": { @@ -20604,23 +30722,279 @@ "summary": [ { "kind": "text", - "text": "The currency of this money amount." + "text": "The symbol of the currency." } ] }, "type": { - "type": "reference", - "target": 1295, - "name": "CreateCurrencyDTO", - "package": "@medusajs/types" + "type": "intrinsic", + "name": "string" } }, { - "id": 1322, - "name": "currency_code", + "id": 1892, + "name": "symbol_native", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1893, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the currency." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1890, + 1891, + 1892, + 1893 + ] + } + ] + }, + { + "id": 1894, + "name": "FilterableCurrencyProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on a currency." + } + ] + }, + "children": [ + { + "id": 1896, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1894, + "name": "FilterableCurrencyProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1894, + "name": "FilterableCurrencyProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 1897, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1894, + "name": "FilterableCurrencyProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1894, + "name": "FilterableCurrencyProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 1895, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The codes to filter the currencies by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1896, + 1897, + 1895 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1894, + "name": "FilterableCurrencyProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 1898, + "name": "MoneyAmountDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A money amount's data. A money amount represents a price." + } + ] + }, + "children": [ + { + "id": 1899, + "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1900, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { @@ -20635,7 +31009,234 @@ } }, { - "id": 1321, + "id": 1901, + "name": "currency", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The money amount's currency." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 1879, + "name": "CurrencyDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1902, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price of this money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1903, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum quantity required to be purchased for this price to be applied." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1904, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum quantity required to be purchased for this price to be applied." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1905, + "name": "price_set_money_amount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the relation between the money amount and its associated price set." + } + ] + }, + "type": { + "type": "reference", + "target": 2039, + "name": "PriceSetMoneyAmountDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1906, + "name": "created_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the money_amount was created." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1907, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the money_amount was updated." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1908, + "name": "deleted_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the money_amount was deleted." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1899, + 1900, + 1901, + 1902, + 1903, + 1904, + 1905, + 1906, + 1907, + 1908 + ] + } + ] + }, + { + "id": 1909, + "name": "CreateMoneyAmountDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The money amount to create." + } + ] + }, + "children": [ + { + "id": 1910, "name": "id", "variant": "declaration", "kind": 1024, @@ -20656,8 +31257,27 @@ } }, { - "id": 1326, - "name": "max_quantity", + "id": 1911, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currency code of this money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1912, + "name": "currency", "variant": "declaration", "kind": 1024, "flags": { @@ -20667,26 +31287,38 @@ "summary": [ { "kind": "text", - "text": "The maximum quantity required to be purchased for this money amount to be applied." + "text": "The currency of this money amount." } ] }, "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] + "type": "reference", + "target": 1884, + "name": "CreateCurrencyDTO", + "package": "@medusajs/types" } }, { - "id": 1325, + "id": 1913, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of this money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1914, "name": "min_quantity", "variant": "declaration", "kind": 1024, @@ -20714,71 +31346,10 @@ } ] } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1324, - 1323, - 1322, - 1321, - 1326, - 1325 - ] - } - ], - "extendedBy": [ - { - "type": "reference", - "target": 1424, - "name": "CreatePricesDTO" }, { - "type": "reference", - "target": 1556, - "name": "PriceListPriceDTO" - } - ] - }, - { - "id": 1567, - "name": "CreatePriceListDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list to create." - } - ] - }, - "children": [ - { - "id": 1569, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list's description." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1571, - "name": "ends_at", + "id": 1915, + "name": "max_quantity", "variant": "declaration", "kind": 1024, "flags": { @@ -20788,7 +31359,7 @@ "summary": [ { "kind": "text", - "text": "The price list expires after this date." + "text": "The maximum quantity required to be purchased for this money amount to be applied." } ] }, @@ -20801,49 +31372,83 @@ }, { "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" + "name": "number" } ] } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1910, + 1911, + 1912, + 1913, + 1914, + 1915 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 2013, + "name": "CreatePricesDTO" }, { - "id": 1576, - "name": "prices", + "type": "reference", + "target": 2145, + "name": "PriceListPriceDTO" + } + ] + }, + { + "id": 1916, + "name": "UpdateMoneyAmountDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to update in a money amount. The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " is used to identify which money amount to update." + } + ] + }, + "children": [ + { + "id": 1917, + "name": "id", "variant": "declaration", "kind": 1024, - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The prices associated with the price list." + "text": "The ID of the money amount to update." } ] }, "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1556, - "name": "PriceListPriceDTO", - "package": "@medusajs/types" - } + "type": "intrinsic", + "name": "string" } }, { - "id": 1575, - "name": "rules", + "id": 1918, + "name": "currency_code", "variant": "declaration", "kind": 1024, "flags": { @@ -20853,20 +31458,18 @@ "summary": [ { "kind": "text", - "text": "The rules to be created and associated with the price list." + "text": "The code of the currency to associate with the money amount." } ] }, "type": { - "type": "reference", - "target": 1566, - "name": "CreatePriceListRules", - "package": "@medusajs/types" + "type": "intrinsic", + "name": "string" } }, { - "id": 1574, - "name": "rules_count", + "id": 1919, + "name": "amount", "variant": "declaration", "kind": 1024, "flags": { @@ -20876,7 +31479,7 @@ "summary": [ { "kind": "text", - "text": "The number of rules associated with the price list." + "text": "The price of this money amount." } ] }, @@ -20886,7 +31489,447 @@ } }, { - "id": 1570, + "id": 1920, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum quantity required to be purchased for this money amount to be applied." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1921, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum quantity required to be purchased for this money amount to be applied." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1917, + 1918, + 1919, + 1920, + 1921 + ] + } + ] + }, + { + "id": 1922, + "name": "FilterableMoneyAmountProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on a money amount." + } + ] + }, + "children": [ + { + "id": 1925, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1922, + "name": "FilterableMoneyAmountProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1922, + "name": "FilterableMoneyAmountProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 1926, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1922, + "name": "FilterableMoneyAmountProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1922, + "name": "FilterableMoneyAmountProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 1923, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter money amounts by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1924, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Currency codes to filter money amounts by." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1925, + 1926, + 1923, + 1924 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1922, + "name": "FilterableMoneyAmountProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 2127, + "name": "PriceListStatus", + "variant": "declaration", + "kind": 8, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's status." + } + ] + }, + "children": [ + { + "id": 2128, + "name": "ACTIVE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list is enabled and its prices can be used." + } + ] + }, + "type": { + "type": "literal", + "value": "active" + } + }, + { + "id": 2129, + "name": "DRAFT", + "variant": "declaration", + "kind": 16, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list is disabled, meaning its prices can't be used yet." + } + ] + }, + "type": { + "type": "literal", + "value": "draft" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 2128, + 2129 + ] + } + ] + }, + { + "id": 2130, + "name": "PriceListType", + "variant": "declaration", + "kind": 8, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's type." + } + ] + }, + "children": [ + { + "id": 2131, + "name": "SALE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's prices are used for a sale." + } + ] + }, + "type": { + "type": "literal", + "value": "sale" + } + }, + { + "id": 2132, + "name": "OVERRIDE", + "variant": "declaration", + "kind": 16, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's prices override original prices. This affects the calculated price of associated price sets." + } + ] + }, + "type": { + "type": "literal", + "value": "override" + } + } + ], + "groups": [ + { + "title": "Enumeration Members", + "children": [ + 2131, + 2132 + ] + } + ] + }, + { + "id": 2133, + "name": "PriceListDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A price list's details." + } + ] + }, + "children": [ + { + "id": 2134, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2135, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's title." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2136, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -20911,21 +31954,12 @@ { "type": "intrinsic", "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" } ] } }, { - "id": 1572, + "id": 2137, "name": "status", "variant": "declaration", "kind": 1024, @@ -20942,33 +31976,14 @@ }, "type": { "type": "reference", - "target": 1538, + "target": 2127, "name": "PriceListStatus", "package": "@medusajs/types" } }, { - "id": 1568, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list's title." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1573, - "name": "type", + "id": 2138, + "name": "ends_at", "variant": "declaration", "kind": 1024, "flags": { @@ -20978,15 +31993,188 @@ "summary": [ { "kind": "text", - "text": "The price list's type." + "text": "The price list expires after this date." } ] }, "type": { - "type": "reference", - "target": 1541, - "name": "PriceListType", - "package": "@medusajs/types" + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 2139, + "name": "rules_count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of rules associated with this price list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2140, + "name": "price_set_money_amounts", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated price set money amounts." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2039, + "name": "PriceSetMoneyAmountDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 2141, + "name": "money_amounts", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated money amounts." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1898, + "name": "MoneyAmountDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 2142, + "name": "rule_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated rule types." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2106, + "name": "RuleTypeDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 2143, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price set's rules." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2196, + "name": "PriceListRuleDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 2144, + "name": "price_list_rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price set's rules." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2196, + "name": "PriceListRuleDTO", + "package": "@medusajs/types" + } } } ], @@ -20994,22 +32182,24 @@ { "title": "Properties", "children": [ - 1569, - 1571, - 1576, - 1575, - 1574, - 1570, - 1572, - 1568, - 1573 + 2134, + 2135, + 2136, + 2137, + 2138, + 2139, + 2140, + 2141, + 2142, + 2143, + 2144 ] } ] }, { - "id": 1613, - "name": "CreatePriceListRuleDTO", + "id": 2145, + "name": "PriceListPriceDTO", "variant": "declaration", "kind": 256, "flags": {}, @@ -21017,14 +32207,14 @@ "summary": [ { "kind": "text", - "text": "The price list rule to create." + "text": "The prices associated with a price list." } ] }, "children": [ { - "id": 1617, - "name": "price_list", + "id": 2148, + "name": "id", "variant": "declaration", "kind": 1024, "flags": { @@ -21034,166 +32224,214 @@ "summary": [ { "kind": "text", - "text": "The ID of a price list or the details of an existing price list to be associated with the price list rule." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 1544, - "name": "PriceListDTO", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 1616, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a price list to be associated with the price list rule." + "text": "The ID of the money amount." } ] }, "type": { "type": "intrinsic", "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 1910, + "name": "CreateMoneyAmountDTO.id" } }, { - "id": 1615, - "name": "rule_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a rule type or the details of an existing rule type to be associated with the price list rule." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 1517, - "name": "RuleTypeDTO", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 1614, - "name": "rule_type_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a rule type to be associated with the price list rule." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1617, - 1616, - 1615, - 1614 - ] - } - ] - }, - { - "id": 1628, - "name": "CreatePriceListRuleValueDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1631, - "name": "price_list_rule", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 1607, - "name": "PriceListRuleDTO", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 1630, - "name": "price_list_rule_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1629, - "name": "value", + "id": 2149, + "name": "currency_code", "variant": "declaration", "kind": 1024, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currency code of this money amount." + } + ] + }, "type": { "type": "intrinsic", "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 1911, + "name": "CreateMoneyAmountDTO.currency_code" + } + }, + { + "id": 2150, + "name": "currency", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currency of this money amount." + } + ] + }, + "type": { + "type": "reference", + "target": 1884, + "name": "CreateCurrencyDTO", + "package": "@medusajs/types" + }, + "inheritedFrom": { + "type": "reference", + "target": 1912, + "name": "CreateMoneyAmountDTO.currency" + } + }, + { + "id": 2151, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of this money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "target": 1913, + "name": "CreateMoneyAmountDTO.amount" + } + }, + { + "id": 2152, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum quantity required to be purchased for this money amount to be applied." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 1914, + "name": "CreateMoneyAmountDTO.min_quantity" + } + }, + { + "id": 2153, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum quantity required to be purchased for this money amount to be applied." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 1915, + "name": "CreateMoneyAmountDTO.max_quantity" + } + }, + { + "id": 2146, + "name": "price_set_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price set." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2147, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rules to add to the price. The object's keys are rule types' " + }, + { + "kind": "code", + "text": "`rule_attribute`" + }, + { + "kind": "text", + "text": " attribute, and values are the value of that rule associated with this price." + } + ] + }, + "type": { + "type": "reference", + "target": 2154, + "name": "CreatePriceSetPriceRules", + "package": "@medusajs/types" } } ], @@ -21201,15 +32439,72 @@ { "title": "Properties", "children": [ - 1631, - 1630, - 1629 + 2148, + 2149, + 2150, + 2151, + 2152, + 2153, + 2146, + 2147 ] } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 1909, + "name": "CreateMoneyAmountDTO", + "package": "@medusajs/types" + } ] }, { - "id": 1566, + "id": 2154, + "name": "CreatePriceSetPriceRules", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price rules to be set for each price in the price set.\n\nEach key of the object is a rule type's " + }, + { + "kind": "code", + "text": "`rule_attribute`" + }, + { + "kind": "text", + "text": ", and its value\nis the values of the rule." + } + ] + }, + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Record", + "package": "typescript" + } + ] + }, + { + "id": 2155, "name": "CreatePriceListRules", "variant": "declaration", "kind": 256, @@ -21256,8 +32551,8 @@ ] }, { - "id": 1351, - "name": "CreatePriceRuleDTO", + "id": 2156, + "name": "CreatePriceListDTO", "variant": "declaration", "kind": 256, "flags": {}, @@ -21265,491 +32560,22 @@ "summary": [ { "kind": "text", - "text": "A price rule to create." + "text": "The price list to create." } ] }, "children": [ { - "id": 1353, - "name": "price_set", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID or object of the associated price set." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 1385, - "name": "PriceSetDTO", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 1352, - "name": "price_set_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated price set." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1359, - "name": "price_set_money_amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID or object of the associated price set money amount." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 1450, - "name": "PriceSetMoneyAmountDTO", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 1358, - "name": "price_set_money_amount_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated price set money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1357, - "name": "priority", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The priority of the price rule in comparison to other applicable price rules." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1355, - "name": "rule_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated rule type." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 1517, - "name": "RuleTypeDTO", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 1354, - "name": "rule_type_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated rule type." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1356, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the price rule." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1353, - 1352, - 1359, - 1358, - 1357, - 1355, - 1354, - 1356 - ] - } - ] - }, - { - "id": 1438, - "name": "CreatePriceSetDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A price set to create." - } - ] - }, - "children": [ - { - "id": 1442, - "name": "prices", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prices to create and add to this price set." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1424, - "name": "CreatePricesDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 1439, - "name": "rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The rules to associate with the price set." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1440, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1441, - "name": "rule_attribute", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "the value of the rule's " - }, - { - "kind": "code", - "text": "`rule_attribute`" - }, - { - "kind": "text", - "text": " attribute." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1441 - ] - } - ] - } - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1442, - 1439 - ] - } - ] - }, - { - "id": 1466, - "name": "CreatePriceSetMoneyAmountDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1470, - "name": "money_amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 1309, - "name": "MoneyAmountDTO", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 1469, - "name": "price_list", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 1544, - "name": "PriceListDTO", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 1468, - "name": "price_set", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": 1385, - "name": "PriceSetDTO", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 1471, - "name": "rules_count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1467, + "id": 2157, "name": "title", "variant": "declaration", "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1470, - 1469, - 1468, - 1471, - 1467 - ] - } - ] - }, - { - "id": 1483, - "name": "CreatePriceSetMoneyAmountRulesDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price set money amount rule to create." - } - ] - }, - "children": [ - { - "id": 1484, - "name": "price_set_money_amount", - "variant": "declaration", - "kind": 1024, "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The ID of a price set money amount." + "text": "The price list's title." } ] }, @@ -21759,8 +32585,8 @@ } }, { - "id": 1485, - "name": "rule_type", + "id": 2158, + "name": "description", "variant": "declaration", "kind": 1024, "flags": {}, @@ -21768,7 +32594,7 @@ "summary": [ { "kind": "text", - "text": "The ID of a rule type." + "text": "The price list's description." } ] }, @@ -21778,6493 +32604,7 @@ } }, { - "id": 1486, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the price set money amount rule." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1484, - 1485, - 1486 - ] - } - ] - }, - { - "id": 1565, - "name": "CreatePriceSetPriceRules", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price rules to be set for each price in the price set.\n\nEach key of the object is a rule type's " - }, - { - "kind": "code", - "text": "`rule_attribute`" - }, - { - "kind": "text", - "text": ", and its value\nis the values of the rule." - } - ] - }, - "extendedTypes": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "string" - } - ], - "name": "Record", - "package": "typescript" - } - ] - }, - { - "id": 1504, - "name": "CreatePriceSetRuleTypeDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1505, - "name": "price_set", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 1385, - "name": "PriceSetDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1506, - "name": "rule_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 1517, - "name": "RuleTypeDTO", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1505, - 1506 - ] - } - ] - }, - { - "id": 1424, - "name": "CreatePricesDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prices to create part of a price set." - } - ] - }, - "children": [ - { - "id": 1429, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The amount of this money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1324, - "name": "CreateMoneyAmountDTO.amount" - } - }, - { - "id": 1428, - "name": "currency", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The currency of this money amount." - } - ] - }, - "type": { - "type": "reference", - "target": 1295, - "name": "CreateCurrencyDTO", - "package": "@medusajs/types" - }, - "inheritedFrom": { - "type": "reference", - "target": 1323, - "name": "CreateMoneyAmountDTO.currency" - } - }, - { - "id": 1427, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The currency code of this money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1322, - "name": "CreateMoneyAmountDTO.currency_code" - } - }, - { - "id": 1426, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1321, - "name": "CreateMoneyAmountDTO.id" - } - }, - { - "id": 1431, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum quantity required to be purchased for this money amount to be applied." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1326, - "name": "CreateMoneyAmountDTO.max_quantity" - } - }, - { - "id": 1430, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The minimum quantity required to be purchased for this money amount to be applied." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1325, - "name": "CreateMoneyAmountDTO.min_quantity" - } - }, - { - "id": 1425, - "name": "rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The rules to add to the price. The object's keys are rule types' " - }, - { - "kind": "code", - "text": "`rule_attribute`" - }, - { - "kind": "text", - "text": " attribute, and values are the value of that rule associated with this price." - } - ] - }, - "type": { - "type": "reference", - "target": 1565, - "name": "CreatePriceSetPriceRules", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1429, - 1428, - 1427, - 1426, - 1431, - 1430, - 1425 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 1320, - "name": "CreateMoneyAmountDTO", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1522, - "name": "CreateRuleTypeDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The rule type to create." - } - ] - }, - "children": [ - { - "id": 1526, - "name": "default_priority", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. \nThe higher the value, the higher the priority of the rule type." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1523, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the rule type." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1524, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The display name of the rule type." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1525, - "name": "rule_attribute", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The unique name used to later identify the rule_attribute. For example, it can be used in the " - }, - { - "kind": "code", - "text": "`context`" - }, - { - "kind": "text", - "text": " parameter of the " - }, - { - "kind": "code", - "text": "`calculatePrices`" - }, - { - "kind": "text", - "text": " \nmethod to specify a rule for calculating the price." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1526, - 1523, - 1524, - 1525 - ] - } - ] - }, - { - "id": 1290, - "name": "CurrencyDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A currency's data." - } - ] - }, - "children": [ - { - "id": 1291, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The code of the currency." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1294, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The name of the currency." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1292, - "name": "symbol", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The symbol of the currency." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1293, - "name": "symbol_native", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1291, - 1294, - 1292, - 1293 - ] - } - ] - }, - { - "id": 137, - "name": "FilterableAuthProviderProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object used to allow specifying flexible queries with and/or conditions." - } - ] - }, - "children": [ - { - "id": 142, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 137, - "name": "FilterableAuthProviderProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 137, - "name": "FilterableAuthProviderProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 143, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 137, - "name": "FilterableAuthProviderProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 137, - "name": "FilterableAuthProviderProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 140, - "name": "domain", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 133, - "name": "ProviderDomain", - "package": "@medusajs/types" - } - } - }, - { - "id": 139, - "name": "is_active", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 141, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 138, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 142, - 143, - 140, - 139, - 141, - 138 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 137, - "name": "FilterableAuthProviderProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 110, - "name": "FilterableAuthUserProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object used to allow specifying flexible queries with and/or conditions." - } - ] - }, - "children": [ - { - "id": 113, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 110, - "name": "FilterableAuthUserProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 110, - "name": "FilterableAuthUserProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 114, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 110, - "name": "FilterableAuthUserProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 110, - "name": "FilterableAuthUserProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 111, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 112, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 113, - 114, - 111, - 112 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 110, - "name": "FilterableAuthUserProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1305, - "name": "FilterableCurrencyProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on a currency." - } - ] - }, - "children": [ - { - "id": 1307, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1305, - "name": "FilterableCurrencyProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1305, - "name": "FilterableCurrencyProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 1308, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1305, - "name": "FilterableCurrencyProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1305, - "name": "FilterableCurrencyProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 1306, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The codes to filter the currencies by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1307, - 1308, - 1306 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1305, - "name": "FilterableCurrencyProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1333, - "name": "FilterableMoneyAmountProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on a money amount." - } - ] - }, - "children": [ - { - "id": 1336, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1333, - "name": "FilterableMoneyAmountProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1333, - "name": "FilterableMoneyAmountProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 1337, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1333, - "name": "FilterableMoneyAmountProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1333, - "name": "FilterableMoneyAmountProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 1335, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Currency codes to filter money amounts by." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - }, - { - "id": 1334, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter money amounts by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1336, - 1337, - 1335, - 1334 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1333, - "name": "FilterableMoneyAmountProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1586, - "name": "FilterablePriceListProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on price lists." - } - ] - }, - "children": [ - { - "id": 1592, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1586, - "name": "FilterablePriceListProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1586, - "name": "FilterablePriceListProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 1593, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1586, - "name": "FilterablePriceListProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1586, - "name": "FilterablePriceListProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 1589, - "name": "ends_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The end dates to filter price lists by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1587, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs to filter price lists by" - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1591, - "name": "rules_count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of rules to filter price lists by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "number" - } - } - }, - { - "id": 1588, - "name": "starts_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The start dates to filter price lists by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1590, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The statuses to filter price lists by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1538, - "name": "PriceListStatus", - "package": "@medusajs/types" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1592, - 1593, - 1589, - 1587, - 1591, - 1588, - 1590 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1586, - "name": "FilterablePriceListProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1594, - "name": "FilterablePriceListRuleProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on price list rules." - } - ] - }, - "children": [ - { - "id": 1599, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1594, - "name": "FilterablePriceListRuleProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1594, - "name": "FilterablePriceListRuleProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 1600, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1594, - "name": "FilterablePriceListRuleProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1594, - "name": "FilterablePriceListRuleProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 1595, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs to filter price list rules by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1598, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter price list rules by the ID of their associated price lists." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1597, - "name": "rule_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filter price list rules by the ID of their associated rule types." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1596, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The values to filter price list rules by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1599, - 1600, - 1595, - 1598, - 1597, - 1596 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1594, - "name": "FilterablePriceListRuleProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1601, - "name": "FilterablePriceListRuleValueProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object used to allow specifying flexible queries with and/or conditions." - } - ] - }, - "children": [ - { - "id": 1605, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1601, - "name": "FilterablePriceListRuleValueProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1601, - "name": "FilterablePriceListRuleValueProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 1606, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1601, - "name": "FilterablePriceListRuleValueProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1601, - "name": "FilterablePriceListRuleValueProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 1602, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1604, - "name": "price_list_rule_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1603, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1605, - 1606, - 1602, - 1604, - 1603 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1601, - "name": "FilterablePriceListRuleValueProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1368, - "name": "FilterablePriceRuleProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on price rules." - } - ] - }, - "children": [ - { - "id": 1373, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1368, - "name": "FilterablePriceRuleProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1368, - "name": "FilterablePriceRuleProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 1374, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1368, - "name": "FilterablePriceRuleProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1368, - "name": "FilterablePriceRuleProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 1369, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs to filter price rules by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1370, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The names to filter price rules by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1371, - "name": "price_set_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs to filter the price rule's associated price set." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1372, - "name": "rule_type_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs to filter the price rule's associated rule type." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1373, - 1374, - 1369, - 1370, - 1371, - 1372 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1368, - "name": "FilterablePriceRuleProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1472, - "name": "FilterablePriceSetMoneyAmountProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on price set money amounts." - } - ] - }, - "children": [ - { - "id": 1476, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1472, - "name": "FilterablePriceSetMoneyAmountProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1472, - "name": "FilterablePriceSetMoneyAmountProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 1477, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1472, - "name": "FilterablePriceSetMoneyAmountProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1472, - "name": "FilterablePriceSetMoneyAmountProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 1473, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs to filter the price set money amounts by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1475, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs to filter the price set money amount's associated price list." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1474, - "name": "price_set_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs to filter the price set money amount's associated price set." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1476, - 1477, - 1473, - 1475, - 1474 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1472, - "name": "FilterablePriceSetMoneyAmountProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1492, - "name": "FilterablePriceSetMoneyAmountRulesProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on price set money amount rules." - } - ] - }, - "children": [ - { - "id": 1497, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1492, - "name": "FilterablePriceSetMoneyAmountRulesProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1492, - "name": "FilterablePriceSetMoneyAmountRulesProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 1498, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1492, - "name": "FilterablePriceSetMoneyAmountRulesProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1492, - "name": "FilterablePriceSetMoneyAmountRulesProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 1493, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID to filter price set money amount rules by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1495, - "name": "price_set_money_amount_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs to filter the price set money amount rule's associated price set money amount." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1494, - "name": "rule_type_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs to filter the price set money amount rule's associated rule type." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1496, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value to filter price set money amount rules by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1497, - 1498, - 1493, - 1495, - 1494, - 1496 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1492, - "name": "FilterablePriceSetMoneyAmountRulesProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1445, - "name": "FilterablePriceSetProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on price sets." - } - ] - }, - "children": [ - { - "id": 1448, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1445, - "name": "FilterablePriceSetProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1445, - "name": "FilterablePriceSetProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 1449, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1445, - "name": "FilterablePriceSetProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1445, - "name": "FilterablePriceSetProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 1446, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "IDs to filter price sets by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1447, - "name": "money_amounts", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on a price set's associated money amounts." - } - ] - }, - "type": { - "type": "reference", - "target": 1333, - "name": "FilterableMoneyAmountProps", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1448, - 1449, - 1446, - 1447 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1445, - "name": "FilterablePriceSetProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1511, - "name": "FilterablePriceSetRuleTypeProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An object used to allow specifying flexible queries with and/or conditions." - } - ] - }, - "children": [ - { - "id": 1515, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1511, - "name": "FilterablePriceSetRuleTypeProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1511, - "name": "FilterablePriceSetRuleTypeProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 1516, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1511, - "name": "FilterablePriceSetRuleTypeProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1511, - "name": "FilterablePriceSetRuleTypeProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 1512, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1514, - "name": "price_set_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1513, - "name": "rule_type_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1515, - 1516, - 1512, - 1514, - 1513 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1511, - "name": "FilterablePriceSetRuleTypeProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1532, - "name": "FilterableRuleTypeProps", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Filters to apply on rule types." - } - ] - }, - "children": [ - { - "id": 1536, - "name": "$and", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1532, - "name": "FilterableRuleTypeProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1532, - "name": "FilterableRuleTypeProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 419, - "name": "BaseFilterable.$and" - } - }, - { - "id": 1537, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1532, - "name": "FilterableRuleTypeProps", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1532, - "name": "FilterableRuleTypeProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 420, - "name": "BaseFilterable.$or" - } - }, - { - "id": 1533, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The IDs to filter rule types by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1534, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The names to filter rule types by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1535, - "name": "rule_attribute", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The rule attributes to filter rule types by." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1536, - 1537, - 1533, - 1534, - 1535 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 418, - "typeArguments": [ - { - "type": "reference", - "target": 1532, - "name": "FilterableRuleTypeProps", - "package": "@medusajs/types" - } - ], - "name": "BaseFilterable", - "package": "@medusajs/types" - } - ] - }, - { - "id": 16, - "name": "IAuthenticationModuleService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 85, - "name": "__hooks", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 86, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 87, - "name": "onApplicationStart", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 88, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "signatures": [ - { - "id": 89, - "name": "__type", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 87 - ] - } - ] - } - }, - "inheritedFrom": { - "type": "reference", - "target": 846, - "name": "IModuleService.__hooks" - } - }, - { - "id": 83, - "name": "__joinerConfig", - "variant": "declaration", - "kind": 2048, - "flags": { - "isOptional": true - }, - "signatures": [ - { - "id": 84, - "name": "__joinerConfig", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": 771, - "name": "ModuleJoinerConfig", - "package": "@medusajs/types" - }, - "inheritedFrom": { - "type": "reference", - "target": 845, - "name": "IModuleService.__joinerConfig" - } - } - ], - "inheritedFrom": { - "type": "reference", - "target": 844, - "name": "IModuleService.__joinerConfig" - } - }, - { - "id": 32, - "name": "createAuthProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 33, - "name": "createAuthProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 34, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 121, - "name": "CreateAuthProviderDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 35, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 115, - "name": "AuthProviderDTO", - "package": "@medusajs/types" - } - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 36, - "name": "createAuthProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 37, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 121, - "name": "CreateAuthProviderDTO", - "package": "@medusajs/types" - } - }, - { - "id": 38, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 115, - "name": "AuthProviderDTO", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 65, - "name": "createAuthUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 66, - "name": "createAuthUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 67, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 98, - "name": "CreateAuthUserDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 68, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 90, - "name": "AuthUserDTO", - "package": "@medusajs/types" - } - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 69, - "name": "createAuthUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 70, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 98, - "name": "CreateAuthUserDTO", - "package": "@medusajs/types" - } - }, - { - "id": 71, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 90, - "name": "AuthUserDTO", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 46, - "name": "deleteAuthProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 47, - "name": "deleteAuthProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 48, - "name": "ids", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 49, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 79, - "name": "deleteAuthUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 80, - "name": "deleteAuthUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 81, - "name": "ids", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 82, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 27, - "name": "listAndCountAuthProviders", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 28, - "name": "listAndCountAuthProviders", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 29, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 137, - "name": "FilterableAuthProviderProps", - "package": "@medusajs/types" - } - }, - { - "id": 30, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 221, - "typeArguments": [ - { - "type": "reference", - "target": 115, - "name": "AuthProviderDTO", - "package": "@medusajs/types" - } - ], - "name": "FindConfig", - "package": "@medusajs/types" - } - }, - { - "id": 31, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "tuple", - "elements": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 115, - "name": "AuthProviderDTO", - "package": "@medusajs/types" - } - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 60, - "name": "listAndCountAuthUsers", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 61, - "name": "listAndCountAuthUsers", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 62, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 110, - "name": "FilterableAuthUserProps", - "package": "@medusajs/types" - } - }, - { - "id": 63, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 221, - "typeArguments": [ - { - "type": "reference", - "target": 90, - "name": "AuthUserDTO", - "package": "@medusajs/types" - } - ], - "name": "FindConfig", - "package": "@medusajs/types" - } - }, - { - "id": 64, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "tuple", - "elements": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 90, - "name": "AuthUserDTO", - "package": "@medusajs/types" - } - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 22, - "name": "listAuthProviders", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 23, - "name": "listAuthProviders", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 24, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 137, - "name": "FilterableAuthProviderProps", - "package": "@medusajs/types" - } - }, - { - "id": 25, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 221, - "typeArguments": [ - { - "type": "reference", - "target": 115, - "name": "AuthProviderDTO", - "package": "@medusajs/types" - } - ], - "name": "FindConfig", - "package": "@medusajs/types" - } - }, - { - "id": 26, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 115, - "name": "AuthProviderDTO", - "package": "@medusajs/types" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 55, - "name": "listAuthUsers", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 56, - "name": "listAuthUsers", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 57, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 137, - "name": "FilterableAuthProviderProps", - "package": "@medusajs/types" - } - }, - { - "id": 58, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 221, - "typeArguments": [ - { - "type": "reference", - "target": 90, - "name": "AuthUserDTO", - "package": "@medusajs/types" - } - ], - "name": "FindConfig", - "package": "@medusajs/types" - } - }, - { - "id": 59, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 90, - "name": "AuthUserDTO", - "package": "@medusajs/types" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 17, - "name": "retrieveAuthProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 18, - "name": "retrieveAuthProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 19, - "name": "provider", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 20, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 221, - "typeArguments": [ - { - "type": "reference", - "target": 115, - "name": "AuthProviderDTO", - "package": "@medusajs/types" - } - ], - "name": "FindConfig", - "package": "@medusajs/types" - } - }, - { - "id": 21, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 115, - "name": "AuthProviderDTO", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 50, - "name": "retrieveAuthUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 51, - "name": "retrieveAuthUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 52, - "name": "id", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 53, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 221, - "typeArguments": [ - { - "type": "reference", - "target": 90, - "name": "AuthUserDTO", - "package": "@medusajs/types" - } - ], - "name": "FindConfig", - "package": "@medusajs/types" - } - }, - { - "id": 54, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 90, - "name": "AuthUserDTO", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 39, - "name": "updateAuthProvider", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 40, - "name": "updateAuthProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 41, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 127, - "name": "UpdateAuthProviderDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 42, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 115, - "name": "AuthProviderDTO", - "package": "@medusajs/types" - } - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 43, - "name": "updateAuthProvider", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 44, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 127, - "name": "UpdateAuthProviderDTO", - "package": "@medusajs/types" - } - }, - { - "id": 45, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 115, - "name": "AuthProviderDTO", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 72, - "name": "updateAuthUser", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 73, - "name": "updateAuthUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 74, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 104, - "name": "UpdateAuthUserDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 75, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 90, - "name": "AuthUserDTO", - "package": "@medusajs/types" - } - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 76, - "name": "updateAuthUser", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 77, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 104, - "name": "UpdateAuthUserDTO", - "package": "@medusajs/types" - } - }, - { - "id": 78, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "reference", - "target": 90, - "name": "AuthUserDTO", - "package": "@medusajs/types" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 85 - ] - }, - { - "title": "Methods", - "children": [ - 83, - 32, - 65, - 46, - 79, - 27, - 60, - 22, - 55, - 17, - 50, - 39, - 72 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 843, - "name": "IModuleService", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1253, - "name": "ILinkModule", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1254, - "name": "__joinerConfig", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1255, - "name": "__joinerConfig", - "variant": "signature", - "kind": 4096, - "flags": {}, - "type": { - "type": "reference", - "target": 771, - "name": "ModuleJoinerConfig", - "package": "@medusajs/types" - } - } - ] - }, - { - "id": 1266, - "name": "create", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1267, - "name": "create", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1268, - "name": "primaryKeyOrBulkData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "optional", - "elementType": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ] - } - } - ] - } - }, - { - "id": 1269, - "name": "foreignKeyData", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1270, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1276, - "name": "delete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1277, - "name": "delete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1278, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1279, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "void" - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1271, - "name": "dismiss", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1272, - "name": "dismiss", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1273, - "name": "primaryKeyOrBulkData", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - }, - { - "type": "array", - "elementType": { - "type": "tuple", - "elements": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - } - ] - } - }, - { - "id": 1274, - "name": "foreignKeyData", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1275, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1256, - "name": "list", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1257, - "name": "list", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1258, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1259, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 221, - "typeArguments": [ - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "FindConfig", - "package": "@medusajs/types" - } - }, - { - "id": 1260, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1261, - "name": "listAndCount", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1262, - "name": "listAndCount", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1263, - "name": "filters", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1264, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 221, - "typeArguments": [ - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "FindConfig", - "package": "@medusajs/types" - } - }, - { - "id": 1265, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "tuple", - "elements": [ - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "type": "intrinsic", - "name": "number" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1285, - "name": "restore", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1286, - "name": "restore", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1287, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1288, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 536, - "name": "RestoreReturn", - "package": "@medusajs/types" - } - }, - { - "id": 1289, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - }, - { - "id": 1280, - "name": "softDelete", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1281, - "name": "softDelete", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1282, - "name": "data", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "unknown" - } - }, - { - "id": 1283, - "name": "config", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 533, - "name": "SoftDeleteReturn", - "package": "@medusajs/types" - } - }, - { - "id": 1284, - "name": "sharedContext", - "variant": "param", - "kind": 32768, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "void" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "unknown" - } - } - ], - "name": "Record", - "package": "typescript" - } - ] - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [ - 1254, - 1266, - 1276, - 1271, - 1256, - 1261, - 1285, - 1280 - ] - } - ] - }, - { - "id": 1721, - "name": "InputPrice", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1724, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1723, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1727, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1726, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1722, - "name": "region_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1725, - "name": "variant_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1724, - 1723, - 1727, - 1726, - 1722, - 1725 - ] - } - ] - }, - { - "id": 1214, - "name": "JoinerArgument", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1215, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1216, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1215, - 1216 - ] - } - ] - }, - { - "id": 1217, - "name": "JoinerDirective", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1218, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1219, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "any" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1218, - 1219 - ] - } - ] - }, - { - "id": 1200, - "name": "JoinerServiceConfig", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1202, - "name": "alias", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Property name to use as entrypoint to the service" - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1197, - "name": "JoinerServiceConfigAlias", - "package": "@medusajs/types" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1197, - "name": "JoinerServiceConfigAlias", - "package": "@medusajs/types" - } - } - ] - } - }, - { - "id": 1213, - "name": "args", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extra arguments to pass to the remoteFetchData callback" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1209, - "name": "extends", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1210, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1212, - "name": "relationship", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 1187, - "name": "JoinerRelationship", - "package": "@medusajs/types" - } - }, - { - "id": 1211, - "name": "serviceName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1212, - 1211 - ] - } - ] - } - } - } - }, - { - "id": 1203, - "name": "fieldAlias", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "alias for deeper nested relationships (e.g. { 'price': 'prices.calculated_price_set.amount' })" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reflection", - "declaration": { - "id": 1204, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1206, - "name": "forwardArgumentsOnPath", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1205, - "name": "path", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1206, - 1205 - ] - } - ] - } - } - ] - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1207, - "name": "primaryKeys", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1208, - "name": "relationships", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1187, - "name": "JoinerRelationship", - "package": "@medusajs/types" - } - } - }, - { - "id": 1201, - "name": "serviceName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1202, - 1213, - 1209, - 1203, - 1207, - 1208, - 1201 - ] - } - ] - }, - { - "id": 1197, - "name": "JoinerServiceConfigAlias", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1199, - "name": "args", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extra arguments to pass to the remoteFetchData callback" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1198, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1199, - 1198 - ] - } - ] - }, - { - "id": 1309, - "name": "MoneyAmountDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A money amount's data. A money amount represents a price." - } - ] - }, - "children": [ - { - "id": 1313, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price of this money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1317, - "name": "created_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the money_amount was created." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1312, - "name": "currency", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The money amount's currency." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "reference", - "target": 1290, - "name": "CurrencyDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1311, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The currency code of this money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1319, - "name": "deleted_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the money_amount was deleted." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 1310, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1315, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum quantity required to be purchased for this price to be applied." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1314, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The minimum quantity required to be purchased for this price to be applied." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1316, - "name": "price_set_money_amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The details of the relation between the money amount and its associated price set." - } - ] - }, - "type": { - "type": "reference", - "target": 1450, - "name": "PriceSetMoneyAmountDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1318, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the money_amount was updated." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1313, - 1317, - 1312, - 1311, - 1319, - 1310, - 1315, - 1314, - 1316, - 1318 - ] - } - ] - }, - { - "id": 1544, - "name": "PriceListDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A price list's details." - } - ] - }, - "children": [ - { - "id": 1549, - "name": "ends_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list expires after this date." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - } - ] - } - }, - { - "id": 1545, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list's ID." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1552, - "name": "money_amounts", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated money amounts." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1309, - "name": "MoneyAmountDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 1555, - "name": "price_list_rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price set's rules." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1607, - "name": "PriceListRuleDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 1551, - "name": "price_set_money_amounts", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated price set money amounts." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1450, - "name": "PriceSetMoneyAmountDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 1553, - "name": "rule_types", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated rule types." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1517, - "name": "RuleTypeDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 1554, - "name": "rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price set's rules." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1607, - "name": "PriceListRuleDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 1550, - "name": "rules_count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of rules associated with this price list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1547, + "id": 2159, "name": "starts_at", "variant": "declaration", "kind": 1024, @@ -28289,12 +32629,60 @@ { "type": "intrinsic", "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" } ] } }, { - "id": 1548, + "id": 2160, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list expires after this date." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 2161, "name": "status", "variant": "declaration", "kind": 1024, @@ -28311,13 +32699,158 @@ }, "type": { "type": "reference", - "target": 1538, + "target": 2127, "name": "PriceListStatus", "package": "@medusajs/types" } }, { - "id": 1546, + "id": 2162, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's type." + } + ] + }, + "type": { + "type": "reference", + "target": 2130, + "name": "PriceListType", + "package": "@medusajs/types" + } + }, + { + "id": 2163, + "name": "rules_count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of rules associated with the price list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2164, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rules to be created and associated with the price list." + } + ] + }, + "type": { + "type": "reference", + "target": 2155, + "name": "CreatePriceListRules", + "package": "@medusajs/types" + } + }, + { + "id": 2165, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prices associated with the price list." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2145, + "name": "PriceListPriceDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2157, + 2158, + 2159, + 2160, + 2161, + 2162, + 2163, + 2164, + 2165 + ] + } + ] + }, + { + "id": 2166, + "name": "UpdatePriceListDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attributes to update in a price list." + } + ] + }, + "children": [ + { + "id": 2167, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the price list to update." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2168, "name": "title", "variant": "declaration", "kind": 1024, @@ -28336,235 +32869,152 @@ "type": "intrinsic", "name": "string" } - } - ], - "groups": [ + }, { - "title": "Properties", - "children": [ - 1549, - 1545, - 1552, - 1555, - 1551, - 1553, - 1554, - 1550, - 1547, - 1548, - 1546 - ] - } - ] - }, - { - "id": 1556, - "name": "PriceListPriceDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The prices associated with a price list." - } - ] - }, - "children": [ - { - "id": 1562, - "name": "amount", + "id": 2169, + "name": "description", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { "kind": "text", - "text": "The amount of this money amount." + "text": "The price list's description." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2170, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list is enabled starting from this date." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 2171, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list expires after this date." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + ] + } + }, + { + "id": 2172, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list's status." + } + ] + }, + "type": { + "type": "reference", + "target": 2127, + "name": "PriceListStatus", + "package": "@medusajs/types" + } + }, + { + "id": 2173, + "name": "rules_count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of rules associated with the price list." } ] }, "type": { "type": "intrinsic", "name": "number" - }, - "inheritedFrom": { - "type": "reference", - "target": 1324, - "name": "CreateMoneyAmountDTO.amount" } }, { - "id": 1561, - "name": "currency", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The currency of this money amount." - } - ] - }, - "type": { - "type": "reference", - "target": 1295, - "name": "CreateCurrencyDTO", - "package": "@medusajs/types" - }, - "inheritedFrom": { - "type": "reference", - "target": 1323, - "name": "CreateMoneyAmountDTO.currency" - } - }, - { - "id": 1560, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The currency code of this money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1322, - "name": "CreateMoneyAmountDTO.currency_code" - } - }, - { - "id": 1559, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - }, - "inheritedFrom": { - "type": "reference", - "target": 1321, - "name": "CreateMoneyAmountDTO.id" - } - }, - { - "id": 1564, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum quantity required to be purchased for this money amount to be applied." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1326, - "name": "CreateMoneyAmountDTO.max_quantity" - } - }, - { - "id": 1563, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The minimum quantity required to be purchased for this money amount to be applied." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "number" - } - ] - }, - "inheritedFrom": { - "type": "reference", - "target": 1325, - "name": "CreateMoneyAmountDTO.min_quantity" - } - }, - { - "id": 1557, - "name": "price_set_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated price set." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1558, + "id": 2174, "name": "rules", "variant": "declaration", "kind": 1024, @@ -28575,22 +33025,14 @@ "summary": [ { "kind": "text", - "text": "The rules to add to the price. The object's keys are rule types' " - }, - { - "kind": "code", - "text": "`rule_attribute`" - }, - { - "kind": "text", - "text": " attribute, and values are the value of that rule associated with this price." + "text": "The rules to be created and associated with the price list." } ] }, "type": { "type": "reference", - "target": 1565, - "name": "CreatePriceSetPriceRules", + "target": 2155, + "name": "CreatePriceListRules", "package": "@medusajs/types" } } @@ -28599,28 +33041,724 @@ { "title": "Properties", "children": [ - 1562, - 1561, - 1560, - 1559, - 1564, - 1563, - 1557, - 1558 + 2167, + 2168, + 2169, + 2170, + 2171, + 2172, + 2173, + 2174 + ] + } + ] + }, + { + "id": 2175, + "name": "FilterablePriceListProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on price lists." + } + ] + }, + "children": [ + { + "id": 2181, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2175, + "name": "FilterablePriceListProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2175, + "name": "FilterablePriceListProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 2182, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2175, + "name": "FilterablePriceListProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2175, + "name": "FilterablePriceListProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 2176, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs to filter price lists by" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2177, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The start dates to filter price lists by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2178, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The end dates to filter price lists by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2179, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The statuses to filter price lists by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2127, + "name": "PriceListStatus", + "package": "@medusajs/types" + } + } + }, + { + "id": 2180, + "name": "rules_count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The number of rules to filter price lists by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "number" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2181, + 2182, + 2176, + 2177, + 2178, + 2179, + 2180 ] } ], "extendedTypes": [ { "type": "reference", - "target": 1320, - "name": "CreateMoneyAmountDTO", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2175, + "name": "FilterablePriceListProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", "package": "@medusajs/types" } ] }, { - "id": 1607, + "id": 2183, + "name": "FilterablePriceListRuleProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on price list rules." + } + ] + }, + "children": [ + { + "id": 2188, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2183, + "name": "FilterablePriceListRuleProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2183, + "name": "FilterablePriceListRuleProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 2189, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2183, + "name": "FilterablePriceListRuleProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2183, + "name": "FilterablePriceListRuleProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 2184, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs to filter price list rules by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2185, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The values to filter price list rules by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2186, + "name": "rule_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter price list rules by the ID of their associated rule types." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2187, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filter price list rules by the ID of their associated price lists." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2188, + 2189, + 2184, + 2185, + 2186, + 2187 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2183, + "name": "FilterablePriceListRuleProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 2190, + "name": "FilterablePriceListRuleValueProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 2194, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2190, + "name": "FilterablePriceListRuleValueProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2190, + "name": "FilterablePriceListRuleValueProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 2195, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2190, + "name": "FilterablePriceListRuleValueProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2190, + "name": "FilterablePriceListRuleValueProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 2191, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2192, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2193, + "name": "price_list_rule_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2194, + 2195, + 2191, + 2192, + 2193 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2190, + "name": "FilterablePriceListRuleValueProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 2196, "name": "PriceListRuleDTO", "variant": "declaration", "kind": 256, @@ -28635,7 +33773,7 @@ }, "children": [ { - "id": 1608, + "id": 2197, "name": "id", "variant": "declaration", "kind": 1024, @@ -28654,7 +33792,50 @@ } }, { - "id": 1611, + "id": 2198, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the rule." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2199, + "name": "rule_type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated rule type." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 2106, + "name": "RuleTypeDTO", + "package": "@medusajs/types" + } + }, + { + "id": 2200, "name": "price_list", "variant": "declaration", "kind": 1024, @@ -28672,13 +33853,13 @@ }, "type": { "type": "reference", - "target": 1544, + "target": 2133, "name": "PriceListDTO", "package": "@medusajs/types" } }, { - "id": 1612, + "id": 2201, "name": "price_list_rule_values", "variant": "declaration", "kind": 1024, @@ -28700,39 +33881,178 @@ "type": "array", "elementType": { "type": "reference", - "target": 1624, + "target": 2213, "name": "PriceListRuleValueDTO", "package": "@medusajs/types" } } - }, + } + ], + "groups": [ { - "id": 1610, - "name": "rule_type", + "title": "Properties", + "children": [ + 2197, + 2198, + 2199, + 2200, + 2201 + ] + } + ] + }, + { + "id": 2202, + "name": "CreatePriceListRuleDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list rule to create." + } + ] + }, + "children": [ + { + "id": 2203, + "name": "rule_type_id", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { "kind": "text", - "text": "The associated rule type." + "text": "The ID of a rule type to be associated with the price list rule." } - ], - "modifierTags": [ - "@expandable" ] }, "type": { - "type": "reference", - "target": 1517, - "name": "RuleTypeDTO", - "package": "@medusajs/types" + "type": "intrinsic", + "name": "string" } }, { - "id": 1609, - "name": "value", + "id": 2204, + "name": "rule_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a rule type or the details of an existing rule type to be associated with the price list rule." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 2106, + "name": "RuleTypeDTO", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 2205, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a price list to be associated with the price list rule." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2206, + "name": "price_list", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a price list or the details of an existing price list to be associated with the price list rule." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 2133, + "name": "PriceListDTO", + "package": "@medusajs/types" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2203, + 2204, + 2205, + 2206 + ] + } + ] + }, + { + "id": 2207, + "name": "UpdatePriceListRuleDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The attributes to update in a price list rule." + } + ] + }, + "children": [ + { + "id": 2208, + "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, @@ -28740,7 +34060,91 @@ "summary": [ { "kind": "text", - "text": "The value of the rule." + "text": "The ID of the price list rule to update." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2209, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a price list to be associated with the price list rule." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2210, + "name": "rule_type_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a rule type to be associated with the price list rule." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2211, + "name": "price_list", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a price list to be associated with the price list rule." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2212, + "name": "rule_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a rule type or the details of an existing rule type to be associated with the price list rule." } ] }, @@ -28754,17 +34158,17 @@ { "title": "Properties", "children": [ - 1608, - 1611, - 1612, - 1610, - 1609 + 2208, + 2209, + 2210, + 2211, + 2212 ] } ] }, { - "id": 1624, + "id": 2213, "name": "PriceListRuleValueDTO", "variant": "declaration", "kind": 256, @@ -28779,7 +34183,7 @@ }, "children": [ { - "id": 1625, + "id": 2214, "name": "id", "variant": "declaration", "kind": 1024, @@ -28798,7 +34202,26 @@ } }, { - "id": 1627, + "id": 2215, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rule's value." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2216, "name": "price_list_rule", "variant": "declaration", "kind": 1024, @@ -28816,25 +34239,125 @@ }, "type": { "type": "reference", - "target": 1607, + "target": 2196, "name": "PriceListRuleDTO", "package": "@medusajs/types" } - }, + } + ], + "groups": [ { - "id": 1626, + "title": "Properties", + "children": [ + 2214, + 2215, + 2216 + ] + } + ] + }, + { + "id": 2217, + "name": "CreatePriceListRuleValueDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2218, "name": "value", "variant": "declaration", "kind": 1024, "flags": {}, - "comment": { - "summary": [ + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2219, + "name": "price_list_rule_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2220, + "name": "price_list_rule", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ { - "kind": "text", - "text": "The rule's value." + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 2196, + "name": "PriceListRuleDTO", + "package": "@medusajs/types" } ] - }, + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2218, + 2219, + 2220 + ] + } + ] + }, + { + "id": 2221, + "name": "UpdatePriceListRuleValueDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2222, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2223, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2224, + "name": "price_list_rule_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, "type": { "type": "intrinsic", "name": "string" @@ -28845,15 +34368,258 @@ { "title": "Properties", "children": [ - 1625, - 1627, - 1626 + 2222, + 2223, + 2224 ] } ] }, { - "id": 1338, + "id": 2225, + "name": "AddPriceListPricesDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prices to be added to a price list." + } + ] + }, + "children": [ + { + "id": 2226, + "name": "priceListId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the price list to add prices to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2227, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prices to add." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2145, + "name": "PriceListPriceDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2226, + 2227 + ] + } + ] + }, + { + "id": 2228, + "name": "SetPriceListRulesDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rules to add to a price list." + } + ] + }, + "children": [ + { + "id": 2229, + "name": "priceListId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the price list to add rules to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2230, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rules to add to the price list. Each key of the object is a rule type's " + }, + { + "kind": "code", + "text": "`rule_attribute`" + }, + { + "kind": "text", + "text": ", and its value\nis the value(s) of the rule." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2229, + 2230 + ] + } + ] + }, + { + "id": 2231, + "name": "RemovePriceListRulesDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rules to remove from a price list." + } + ] + }, + "children": [ + { + "id": 2232, + "name": "priceListId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the price list to remove rules from." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2233, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rules to remove from the price list. Each item being a rule type's " + }, + { + "kind": "code", + "text": "`rule_attribute`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2232, + 2233 + ] + } + ] + }, + { + "id": 1927, "name": "PriceRuleDTO", "variant": "declaration", "kind": 256, @@ -28868,7 +34634,188 @@ }, "children": [ { - "id": 1348, + "id": 1928, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the price rule." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1929, + "name": "price_set_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price set." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1930, + "name": "price_set", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated price set." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 1974, + "name": "PriceSetDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1931, + "name": "rule_type_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated rule type." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1932, + "name": "rule_type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated rule type." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 2106, + "name": "RuleTypeDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1933, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the price rule." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1934, + "name": "priority", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The priority of the price rule in comparison to other applicable price rules." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1935, + "name": "price_set_money_amount_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price set money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1936, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1937, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -28892,7 +34839,31 @@ } }, { - "id": 1350, + "id": 1938, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the price_rule was updated." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1939, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -28923,75 +34894,51 @@ } ] } - }, + } + ], + "groups": [ { - "id": 1339, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the price rule." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" + "title": "Properties", + "children": [ + 1928, + 1929, + 1930, + 1931, + 1932, + 1933, + 1934, + 1935, + 1936, + 1937, + 1938, + 1939 + ] + } + ] + }, + { + "id": 1940, + "name": "CreatePriceRuleDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A price rule to create." } - }, + ] + }, + "children": [ { - "id": 1347, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated price list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1341, - "name": "price_set", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated price set." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "reference", - "target": 1385, - "name": "PriceSetDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1340, + "id": 1941, "name": "price_set_id", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { @@ -29006,16 +34953,50 @@ } }, { - "id": 1346, - "name": "price_set_money_amount_id", + "id": 1942, + "name": "price_set", "variant": "declaration", "kind": 1024, - "flags": {}, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { "kind": "text", - "text": "The ID of the associated price set money amount." + "text": "The ID or object of the associated price set." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 1974, + "name": "PriceSetDTO", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 1943, + "name": "rule_type_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated rule type." } ] }, @@ -29025,11 +35006,64 @@ } }, { - "id": 1345, - "name": "priority", + "id": 1944, + "name": "rule_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated rule type." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 2106, + "name": "RuleTypeDTO", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 1945, + "name": "value", "variant": "declaration", "kind": 1024, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the price rule." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1946, + "name": "priority", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, "comment": { "summary": [ { @@ -29044,7 +35078,537 @@ } }, { - "id": 1343, + "id": 1947, + "name": "price_set_money_amount_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price set money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1948, + "name": "price_set_money_amount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID or object of the associated price set money amount." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 2039, + "name": "PriceSetMoneyAmountDTO", + "package": "@medusajs/types" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1941, + 1942, + 1943, + 1944, + 1945, + 1946, + 1947, + 1948 + ] + } + ] + }, + { + "id": 1949, + "name": "UpdatePriceRuleDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to update in a price rule. The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " is used to identify which money amount to update." + } + ] + }, + "children": [ + { + "id": 1950, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1951, + "name": "price_set_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1952, + "name": "rule_type_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1953, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the price rule." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1954, + "name": "priority", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The priority of the price rule in comparison to other applicable price rules." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1955, + "name": "price_set_money_amount_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price set money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1956, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price list." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1950, + 1951, + 1952, + 1953, + 1954, + 1955, + 1956 + ] + } + ] + }, + { + "id": 1957, + "name": "FilterablePriceRuleProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on price rules." + } + ] + }, + "children": [ + { + "id": 1962, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1957, + "name": "FilterablePriceRuleProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1957, + "name": "FilterablePriceRuleProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 1963, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1957, + "name": "FilterablePriceRuleProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1957, + "name": "FilterablePriceRuleProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 1958, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs to filter price rules by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1959, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The names to filter price rules by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1960, + "name": "price_set_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs to filter the price rule's associated price set." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1961, + "name": "rule_type_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs to filter the price rule's associated rule type." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1962, + 1963, + 1958, + 1959, + 1960, + 1961 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1957, + "name": "FilterablePriceRuleProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 2067, + "name": "PriceSetMoneyAmountRulesDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A price set money amount rule's data." + } + ] + }, + "children": [ + { + "id": 2068, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the price set money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2069, + "name": "price_set_money_amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The associated price set money amount." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 2039, + "name": "PriceSetMoneyAmountDTO", + "package": "@medusajs/types" + } + }, + { + "id": 2070, "name": "rule_type", "variant": "declaration", "kind": 1024, @@ -29062,56 +35626,13 @@ }, "type": { "type": "reference", - "target": 1517, + "target": 2106, "name": "RuleTypeDTO", "package": "@medusajs/types" } }, { - "id": 1342, - "name": "rule_type_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated rule type." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1349, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the price_rule was updated." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - }, - { - "id": 1344, + "id": 2071, "name": "value", "variant": "declaration", "kind": 1024, @@ -29120,7 +35641,7 @@ "summary": [ { "kind": "text", - "text": "The value of the price rule." + "text": "The value of the price set money amount rule." } ] }, @@ -29134,25 +35655,17 @@ { "title": "Properties", "children": [ - 1348, - 1350, - 1339, - 1347, - 1341, - 1340, - 1346, - 1345, - 1343, - 1342, - 1349, - 1344 + 2068, + 2069, + 2070, + 2071 ] } ] }, { - "id": 1385, - "name": "PriceSetDTO", + "id": 2072, + "name": "CreatePriceSetMoneyAmountRulesDTO", "variant": "declaration", "kind": 256, "flags": {}, @@ -29160,13 +35673,105 @@ "summary": [ { "kind": "text", - "text": "A price set's data." + "text": "The price set money amount rule to create." } ] }, "children": [ { - "id": 1386, + "id": 2073, + "name": "price_set_money_amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a price set money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2074, + "name": "rule_type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a rule type." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2075, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the price set money amount rule." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2073, + 2074, + 2075 + ] + } + ] + }, + { + "id": 2076, + "name": "UpdatePriceSetMoneyAmountRulesDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to update in a price set money amount rule. The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " is used to identify which money amount to update." + } + ] + }, + "children": [ + { + "id": 2077, "name": "id", "variant": "declaration", "kind": 1024, @@ -29175,7 +35780,7 @@ "summary": [ { "kind": "text", - "text": "The ID of the price set." + "text": "The ID of the price set money amount rule to update." } ] }, @@ -29185,8 +35790,8 @@ } }, { - "id": 1387, - "name": "money_amounts", + "id": 2078, + "name": "price_set_money_amount", "variant": "declaration", "kind": 1024, "flags": { @@ -29196,23 +35801,212 @@ "summary": [ { "kind": "text", - "text": "The prices that belong to this price set." + "text": "The ID of a price set money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2079, + "name": "rule_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a rule type." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2080, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the price set money amount rule." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2077, + 2078, + 2079, + 2080 + ] + } + ] + }, + { + "id": 2081, + "name": "FilterablePriceSetMoneyAmountRulesProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on price set money amount rules." + } + ] + }, + "children": [ + { + "id": 2086, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." } ] }, "type": { "type": "array", "elementType": { - "type": "reference", - "target": 1309, - "name": "MoneyAmountDTO", - "package": "@medusajs/types" + "type": "union", + "types": [ + { + "type": "reference", + "target": 2081, + "name": "FilterablePriceSetMoneyAmountRulesProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2081, + "name": "FilterablePriceSetMoneyAmountRulesProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 2087, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2081, + "name": "FilterablePriceSetMoneyAmountRulesProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2081, + "name": "FilterablePriceSetMoneyAmountRulesProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 2082, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID to filter price set money amount rules by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" } } }, { - "id": 1388, - "name": "rule_types", + "id": 2083, + "name": "rule_type_id", "variant": "declaration", "kind": 1024, "flags": { @@ -29222,17 +36016,63 @@ "summary": [ { "kind": "text", - "text": "The rule types applied on this price set." + "text": "The IDs to filter the price set money amount rule's associated rule type." } ] }, "type": { "type": "array", "elementType": { - "type": "reference", - "target": 1517, - "name": "RuleTypeDTO", - "package": "@medusajs/types" + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2084, + "name": "price_set_money_amount_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs to filter the price set money amount rule's associated price set money amount." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2085, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value to filter price set money amount rules by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" } } } @@ -29241,15 +36081,34 @@ { "title": "Properties", "children": [ - 1386, - 1387, - 1388 + 2086, + 2087, + 2082, + 2083, + 2084, + 2085 ] } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2081, + "name": "FilterablePriceSetMoneyAmountRulesProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } ] }, { - "id": 1450, + "id": 2039, "name": "PriceSetMoneyAmountDTO", "variant": "declaration", "kind": 256, @@ -29264,7 +36123,175 @@ }, "children": [ { - "id": 1458, + "id": 2040, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of a price set money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2041, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The title of the price set money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2042, + "name": "price_set", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price set associated with the price set money amount." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 1974, + "name": "PriceSetDTO", + "package": "@medusajs/types" + } + }, + { + "id": 2043, + "name": "price_list", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price list associated with the price set money amount." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 2133, + "name": "PriceListDTO", + "package": "@medusajs/types" + } + }, + { + "id": 2044, + "name": "price_set_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price set." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2045, + "name": "price_rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price rules associated with the price set money amount." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1927, + "name": "PriceRuleDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 2046, + "name": "money_amount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The money amount associated with the price set money amount." + } + ], + "modifierTags": [ + "@expandable" + ] + }, + "type": { + "type": "reference", + "target": 1898, + "name": "MoneyAmountDTO", + "package": "@medusajs/types" + } + }, + { + "id": 2047, "name": "created_at", "variant": "declaration", "kind": 1024, @@ -29288,7 +36315,31 @@ } }, { - "id": 1460, + "id": 2048, + "name": "updated_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When the price_set_money_amount was updated." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 2049, "name": "deleted_at", "variant": "declaration", "kind": 1024, @@ -29319,20 +36370,51 @@ } ] } - }, + } + ], + "groups": [ { - "id": 1451, + "title": "Properties", + "children": [ + 2040, + 2041, + 2042, + 2043, + 2044, + 2045, + 2046, + 2047, + 2048, + 2049 + ] + } + ] + }, + { + "id": 2050, + "name": "UpdatePriceSetMoneyAmountDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2051, "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a price set money amount." - } - ] + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2052, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, "type": { "type": "intrinsic", @@ -29340,114 +36422,308 @@ } }, { - "id": 1457, - "name": "money_amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The money amount associated with the price set money amount." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "reference", - "target": 1309, - "name": "MoneyAmountDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1454, - "name": "price_list", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list associated with the price set money amount." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "reference", - "target": 1544, - "name": "PriceListDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1456, - "name": "price_rules", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price rules associated with the price set money amount." - } - ], - "modifierTags": [ - "@expandable" - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1338, - "name": "PriceRuleDTO", - "package": "@medusajs/types" - } - } - }, - { - "id": 1453, + "id": 2053, "name": "price_set", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price set associated with the price set money amount." - } - ], - "modifierTags": [ - "@expandable" - ] - }, "type": { "type": "reference", - "target": 1385, + "target": 1974, "name": "PriceSetDTO", "package": "@medusajs/types" } }, { - "id": 1455, + "id": 2054, + "name": "money_amount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1898, + "name": "MoneyAmountDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2051, + 2052, + 2053, + 2054 + ] + } + ] + }, + { + "id": 2055, + "name": "CreatePriceSetMoneyAmountDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2056, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2057, + "name": "price_set", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 1974, + "name": "PriceSetDTO", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 2058, + "name": "price_list", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 2133, + "name": "PriceListDTO", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 2059, + "name": "money_amount", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 1898, + "name": "MoneyAmountDTO", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 2060, + "name": "rules_count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2056, + 2057, + 2058, + 2059, + 2060 + ] + } + ] + }, + { + "id": 2061, + "name": "FilterablePriceSetMoneyAmountProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on price set money amounts." + } + ] + }, + "children": [ + { + "id": 2065, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2061, + "name": "FilterablePriceSetMoneyAmountProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2061, + "name": "FilterablePriceSetMoneyAmountProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 2066, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2061, + "name": "FilterablePriceSetMoneyAmountProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2061, + "name": "FilterablePriceSetMoneyAmountProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 2062, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs to filter the price set money amounts by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2063, "name": "price_set_id", "variant": "declaration", "kind": 1024, @@ -29458,18 +36734,21 @@ "summary": [ { "kind": "text", - "text": "The ID of the associated price set." + "text": "The IDs to filter the price set money amount's associated price set." } ] }, "type": { - "type": "intrinsic", - "name": "string" + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } } }, { - "id": 1452, - "name": "title", + "id": 2064, + "name": "price_list_id", "variant": "declaration", "kind": 1024, "flags": { @@ -29479,37 +36758,16 @@ "summary": [ { "kind": "text", - "text": "The title of the price set money amount." + "text": "The IDs to filter the price set money amount's associated price list." } ] }, "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1459, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "When the price_set_money_amount was updated." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } } } ], @@ -29517,23 +36775,202 @@ { "title": "Properties", "children": [ - 1458, - 1460, - 1451, - 1457, - 1454, - 1456, - 1453, - 1455, - 1452, - 1459 + 2065, + 2066, + 2062, + 2063, + 2064 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2061, + "name": "FilterablePriceSetMoneyAmountProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 2088, + "name": "PriceSetRuleTypeDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2089, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2090, + "name": "price_set", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1974, + "name": "PriceSetDTO", + "package": "@medusajs/types" + } + }, + { + "id": 2091, + "name": "rule_type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 2106, + "name": "RuleTypeDTO", + "package": "@medusajs/types" + } + }, + { + "id": 2092, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2089, + 2090, + 2091, + 2092 ] } ] }, { - "id": 1478, - "name": "PriceSetMoneyAmountRulesDTO", + "id": 2093, + "name": "CreatePriceSetRuleTypeDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2094, + "name": "price_set", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1974, + "name": "PriceSetDTO", + "package": "@medusajs/types" + } + }, + { + "id": 2095, + "name": "rule_type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 2106, + "name": "RuleTypeDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2094, + 2095 + ] + } + ] + }, + { + "id": 2096, + "name": "UpdatePriceSetRuleTypeDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2097, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2098, + "name": "price_set", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2099, + "name": "rule_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2097, + 2098, + 2099 + ] + } + ] + }, + { + "id": 2100, + "name": "FilterablePriceSetRuleTypeProps", "variant": "declaration", "kind": 256, "flags": {}, @@ -29541,95 +36978,157 @@ "summary": [ { "kind": "text", - "text": "A price set money amount rule's data." + "text": "An object used to allow specifying flexible queries with and/or conditions." } ] }, "children": [ { - "id": 1479, + "id": 2104, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2100, + "name": "FilterablePriceSetRuleTypeProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2100, + "name": "FilterablePriceSetRuleTypeProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 2105, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2100, + "name": "FilterablePriceSetRuleTypeProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2100, + "name": "FilterablePriceSetRuleTypeProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 2101, "name": "id", "variant": "declaration", "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the price set money amount." - } - ] + "flags": { + "isOptional": true }, "type": { - "type": "intrinsic", - "name": "string" + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } } }, { - "id": 1480, - "name": "price_set_money_amount", + "id": 2102, + "name": "rule_type_id", "variant": "declaration", "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated price set money amount." - } - ], - "modifierTags": [ - "@expandable" - ] + "flags": { + "isOptional": true }, "type": { - "type": "reference", - "target": 1450, - "name": "PriceSetMoneyAmountDTO", - "package": "@medusajs/types" + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } } }, { - "id": 1481, - "name": "rule_type", + "id": 2103, + "name": "price_set_id", "variant": "declaration", "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The associated rule type." - } - ], - "modifierTags": [ - "@expandable" - ] + "flags": { + "isOptional": true }, "type": { - "type": "reference", - "target": 1517, - "name": "RuleTypeDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1482, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the price set money amount rule." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } } } ], @@ -29637,84 +37136,127 @@ { "title": "Properties", "children": [ - 1479, - 1480, - 1481, - 1482 + 2104, + 2105, + 2101, + 2102, + 2103 ] } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2100, + "name": "FilterablePriceSetRuleTypeProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } ] }, { - "id": 1499, - "name": "PriceSetRuleTypeDTO", + "id": 1964, + "name": "PricingRepositoryService", "variant": "declaration", "kind": 256, "flags": {}, "children": [ { - "id": 1500, - "name": "id", + "id": 1965, + "name": "calculatePrices", "variant": "declaration", - "kind": 1024, + "kind": 2048, "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1501, - "name": "price_set", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 1385, - "name": "PriceSetDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1502, - "name": "rule_type", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 1517, - "name": "RuleTypeDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1503, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } + "signatures": [ + { + "id": 1966, + "name": "calculatePrices", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1967, + "name": "pricingFilters", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1972, + "name": "PricingFilters", + "package": "@medusajs/types" + } + }, + { + "id": 1968, + "name": "pricingContext", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1970, + "name": "PricingContext", + "package": "@medusajs/types" + } + }, + { + "id": 1969, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 1978, + "name": "CalculatedPriceSetDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] } ], "groups": [ { - "title": "Properties", + "title": "Methods", "children": [ - 1500, - 1501, - 1502, - 1503 + 1965 ] } ] }, { - "id": 1381, + "id": 1970, "name": "PricingContext", "variant": "declaration", "kind": 256, @@ -29729,7 +37271,7 @@ }, "children": [ { - "id": 1382, + "id": 1971, "name": "context", "variant": "declaration", "kind": 1024, @@ -29810,13 +37352,13 @@ { "title": "Properties", "children": [ - 1382 + 1971 ] } ] }, { - "id": 1383, + "id": 1972, "name": "PricingFilters", "variant": "declaration", "kind": 256, @@ -29831,7 +37373,7 @@ }, "children": [ { - "id": 1384, + "id": 1973, "name": "id", "variant": "declaration", "kind": 1024, @@ -29857,616 +37399,14 @@ { "title": "Properties", "children": [ - 1384 + 1973 ] } ] }, { - "id": 1375, - "name": "PricingRepositoryService", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1376, - "name": "calculatePrices", - "variant": "declaration", - "kind": 2048, - "flags": {}, - "signatures": [ - { - "id": 1377, - "name": "calculatePrices", - "variant": "signature", - "kind": 4096, - "flags": {}, - "parameters": [ - { - "id": 1378, - "name": "pricingFilters", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1383, - "name": "PricingFilters", - "package": "@medusajs/types" - } - }, - { - "id": 1379, - "name": "pricingContext", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1381, - "name": "PricingContext", - "package": "@medusajs/types" - } - }, - { - "id": 1380, - "name": "context", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "reference", - "target": 1650, - "name": "Context", - "package": "@medusajs/types" - } - } - ], - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1389, - "name": "CalculatedPriceSetDTO", - "package": "@medusajs/types" - } - } - ], - "name": "Promise", - "package": "typescript" - } - } - ] - } - ], - "groups": [ - { - "title": "Methods", - "children": [ - 1376 - ] - } - ] - }, - { - "id": 1645, - "name": "ProductCategoryTransformOptions", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1646, - "name": "includeDescendantsTree", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1646 - ] - } - ], - "extendedTypes": [ - { - "type": "reference", - "target": 287, - "name": "RepositoryTransformOptions", - "package": "@medusajs/types" - } - ] - }, - { - "id": 1245, - "name": "RemoteExpandProperty", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1251, - "name": "args", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1214, - "name": "JoinerArgument", - "package": "@medusajs/types" - } - } - }, - { - "id": 1252, - "name": "expands", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1238, - "name": "RemoteNestedExpands", - "package": "@medusajs/types" - } - }, - { - "id": 1250, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1247, - "name": "parent", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1248, - "name": "parentConfig", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1200, - "name": "JoinerServiceConfig", - "package": "@medusajs/types" - } - }, - { - "id": 1246, - "name": "property", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1249, - "name": "serviceConfig", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 1200, - "name": "JoinerServiceConfig", - "package": "@medusajs/types" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1251, - 1252, - 1250, - 1247, - 1248, - 1246, - 1249 - ] - } - ] - }, - { - "id": 1220, - "name": "RemoteJoinerQuery", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1222, - "name": "alias", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1233, - "name": "args", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1214, - "name": "JoinerArgument", - "package": "@medusajs/types" - } - } - }, - { - "id": 1234, - "name": "directives", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1235, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "indexSignature": { - "id": 1236, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 1237, - "name": "field", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1217, - "name": "JoinerDirective", - "package": "@medusajs/types" - } - } - } - } - } - }, - { - "id": 1223, - "name": "expands", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reflection", - "declaration": { - "id": 1224, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1227, - "name": "args", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1214, - "name": "JoinerArgument", - "package": "@medusajs/types" - } - } - }, - { - "id": 1228, - "name": "directives", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reflection", - "declaration": { - "id": 1229, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "indexSignature": { - "id": 1230, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 1231, - "name": "field", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1217, - "name": "JoinerDirective", - "package": "@medusajs/types" - } - } - } - } - } - }, - { - "id": 1226, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1225, - "name": "property", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1227, - 1228, - 1226, - 1225 - ] - } - ] - } - } - } - }, - { - "id": 1232, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1221, - "name": "service", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1222, - 1233, - 1234, - 1223, - 1232, - 1221 - ] - } - ] - }, - { - "id": 1238, - "name": "RemoteNestedExpands", - "variant": "declaration", - "kind": 256, - "flags": {}, - "indexSignature": { - "id": 1239, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 1240, - "name": "key", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1241, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1243, - "name": "args", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1214, - "name": "JoinerArgument", - "package": "@medusajs/types" - } - } - }, - { - "id": 1244, - "name": "expands", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1238, - "name": "RemoteNestedExpands", - "package": "@medusajs/types" - } - }, - { - "id": 1242, - "name": "fields", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1243, - 1244, - 1242 - ] - } - ] - } - } - } - }, - { - "id": 1642, - "name": "RemovePriceListRulesDTO", + "id": 1974, + "name": "PriceSetDTO", "variant": "declaration", "kind": 256, "flags": {}, @@ -30474,88 +37414,13 @@ "summary": [ { "kind": "text", - "text": "The rules to remove from a price list." + "text": "A price set's data." } ] }, "children": [ { - "id": 1643, - "name": "priceListId", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the price list to remove rules from." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1644, - "name": "rules", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The rules to remove from the price list. Each item being a rule type's " - }, - { - "kind": "code", - "text": "`rule_attribute`" - }, - { - "kind": "text", - "text": "." - } - ] - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1643, - 1644 - ] - } - ] - }, - { - "id": 1435, - "name": "RemovePriceSetRulesDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The rules to remove from a price set." - } - ] - }, - "children": [ - { - "id": 1436, + "id": 1975, "name": "id", "variant": "declaration", "kind": 1024, @@ -30574,7 +37439,1415 @@ } }, { - "id": 1437, + "id": 1976, + "name": "money_amounts", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prices that belong to this price set." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1898, + "name": "MoneyAmountDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1977, + "name": "rule_types", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rule types applied on this price set." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2106, + "name": "RuleTypeDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1975, + 1976, + 1977 + ] + } + ] + }, + { + "id": 1978, + "name": "CalculatedPriceSetDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A calculated price set's data." + } + ] + }, + "children": [ + { + "id": 1979, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1980, + "name": "price_set_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price set." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1981, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The calculated amount. It can possibly be " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": " if there's no price set up for the provided context." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1982, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currency code of the calculated price. It can possibly be " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1983, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum quantity required to be purchased for this price to apply. It's set if the " + }, + { + "kind": "code", + "text": "`quantity`" + }, + { + "kind": "text", + "text": " property is provided in the context. Otherwise, its value will be " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1984, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum quantity required to be purchased for this price to apply. It's set if the " + }, + { + "kind": "code", + "text": "`quantity`" + }, + { + "kind": "text", + "text": " property is provided in the context. Otherwise, its value will be " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1985, + "name": "price_list_type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the associated price list, if any." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1986, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price list, if any." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1979, + 1980, + 1981, + 1982, + 1983, + 1984, + 1985, + 1986 + ] + } + ] + }, + { + "id": 1987, + "name": "CalculatedPriceSet", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The calculated price for a specific price set and context." + } + ] + }, + "children": [ + { + "id": 1988, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the price set." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1989, + "name": "is_calculated_price_price_list", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the calculated price is associated with a price list. During the calculation process, if no valid price list is found,\nthe calculated price is set to the original price, which doesn't belong to a price list. In that case, the value of this property is " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1990, + "name": "calculated_amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of the calculated price, or " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": " if there isn't a calculated price." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 1991, + "name": "is_original_price_price_list", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the original price is associated with a price list. During the calculation process, if the price list of the calculated price is of type override,\nthe original price will be the same as the calculated price. In that case, the value of this property is " + }, + { + "kind": "code", + "text": "`true`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1992, + "name": "original_amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of the original price, or " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": " if there isn't a calculated price." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 1993, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currency code of the calculated price, or null if there isn't a calculated price." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1994, + "name": "calculated_price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the calculated price." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1995, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1996, + "name": "money_amount_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the money amount selected as the calculated price." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1997, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price list, if any." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1998, + "name": "price_list_type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the associated price list, if any." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1999, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`min_quantity`" + }, + { + "kind": "text", + "text": " field defined on a money amount." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 2000, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`max_quantity`" + }, + { + "kind": "text", + "text": " field defined on a money amount." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1996, + 1997, + 1998, + 1999, + 2000 + ] + } + ] + } + } + }, + { + "id": 2001, + "name": "original_price", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the original price." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2002, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2003, + "name": "money_amount_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the money amount selected as the original price." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 2004, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the associated price list, if any." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 2005, + "name": "price_list_type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of the associated price list, if any." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 2006, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`min_quantity`" + }, + { + "kind": "text", + "text": " field defined on a money amount." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 2007, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The " + }, + { + "kind": "code", + "text": "`max_quantity`" + }, + { + "kind": "text", + "text": " field defined on a money amount." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2003, + 2004, + 2005, + 2006, + 2007 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1988, + 1989, + 1990, + 1991, + 1992, + 1993, + 1994, + 2001 + ] + } + ] + }, + { + "id": 2008, + "name": "AddRulesDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rules to add to a price set." + } + ] + }, + "children": [ + { + "id": 2009, + "name": "priceSetId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the price set to add the rules to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2010, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rules to add to a price set." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 2011, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2012, + "name": "attribute", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The value of the rule's " + }, + { + "kind": "code", + "text": "`rule_attribute`" + }, + { + "kind": "text", + "text": " attribute." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2012 + ] + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2009, + 2010 + ] + } + ] + }, + { + "id": 2013, + "name": "CreatePricesDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prices to create part of a price set." + } + ] + }, + "children": [ + { + "id": 2015, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 1910, + "name": "CreateMoneyAmountDTO.id" + } + }, + { + "id": 2016, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currency code of this money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + }, + "inheritedFrom": { + "type": "reference", + "target": 1911, + "name": "CreateMoneyAmountDTO.currency_code" + } + }, + { + "id": 2017, + "name": "currency", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currency of this money amount." + } + ] + }, + "type": { + "type": "reference", + "target": 1884, + "name": "CreateCurrencyDTO", + "package": "@medusajs/types" + }, + "inheritedFrom": { + "type": "reference", + "target": 1912, + "name": "CreateMoneyAmountDTO.currency" + } + }, + { + "id": 2018, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The amount of this money amount." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + }, + "inheritedFrom": { + "type": "reference", + "target": 1913, + "name": "CreateMoneyAmountDTO.amount" + } + }, + { + "id": 2019, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum quantity required to be purchased for this money amount to be applied." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 1914, + "name": "CreateMoneyAmountDTO.min_quantity" + } + }, + { + "id": 2020, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The maximum quantity required to be purchased for this money amount to be applied." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": 1915, + "name": "CreateMoneyAmountDTO.max_quantity" + } + }, + { + "id": 2014, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rules to add to the price. The object's keys are rule types' " + }, + { + "kind": "code", + "text": "`rule_attribute`" + }, + { + "kind": "text", + "text": " attribute, and values are the value of that rule associated with this price." + } + ] + }, + "type": { + "type": "reference", + "target": 2154, + "name": "CreatePriceSetPriceRules", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2015, + 2016, + 2017, + 2018, + 2019, + 2020, + 2014 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 1909, + "name": "CreateMoneyAmountDTO", + "package": "@medusajs/types" + } + ] + }, + { + "id": 2021, + "name": "AddPricesDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prices to add to a price set." + } + ] + }, + "children": [ + { + "id": 2022, + "name": "priceSetId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the price set to add prices to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2023, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prices to add to the price set." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2013, + "name": "CreatePricesDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2022, + 2023 + ] + } + ] + }, + { + "id": 2024, + "name": "RemovePriceSetRulesDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rules to remove from a price set." + } + ] + }, + "children": [ + { + "id": 2025, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the price set." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2026, "name": "rules", "variant": "declaration", "kind": 1024, @@ -30608,14 +38881,376 @@ { "title": "Properties", "children": [ - 1436, - 1437 + 2025, + 2026 ] } ] }, { - "id": 1517, + "id": 2027, + "name": "CreatePriceSetDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A price set to create." + } + ] + }, + "children": [ + { + "id": 2028, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rules to associate with the price set." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 2029, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 2030, + "name": "rule_attribute", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the value of the rule's " + }, + { + "kind": "code", + "text": "`rule_attribute`" + }, + { + "kind": "text", + "text": " attribute." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2030 + ] + } + ] + } + } + } + }, + { + "id": 2031, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prices to create and add to this price set." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2013, + "name": "CreatePricesDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2028, + 2031 + ] + } + ] + }, + { + "id": 2032, + "name": "UpdatePriceSetDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data to update in a price set. The " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " is used to identify which price set to update." + } + ] + }, + "children": [ + { + "id": 2033, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A string indicating the ID of the price set to update." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2033 + ] + } + ] + }, + { + "id": 2034, + "name": "FilterablePriceSetProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on price sets." + } + ] + }, + "children": [ + { + "id": 2037, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2034, + "name": "FilterablePriceSetProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2034, + "name": "FilterablePriceSetProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 2038, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2034, + "name": "FilterablePriceSetProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2034, + "name": "FilterablePriceSetProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 2035, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "IDs to filter price sets by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2036, + "name": "money_amounts", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on a price set's associated money amounts." + } + ] + }, + "type": { + "type": "reference", + "target": 1922, + "name": "FilterableMoneyAmountProps", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2037, + 2038, + 2035, + 2036 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2034, + "name": "FilterablePriceSetProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 2106, "name": "RuleTypeDTO", "variant": "declaration", "kind": 256, @@ -30630,26 +39265,7 @@ }, "children": [ { - "id": 1521, - "name": "default_priority", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1518, + "id": 2107, "name": "id", "variant": "declaration", "kind": 1024, @@ -30668,7 +39284,7 @@ } }, { - "id": 1519, + "id": 2108, "name": "name", "variant": "declaration", "kind": 1024, @@ -30687,7 +39303,7 @@ } }, { - "id": 1520, + "id": 2109, "name": "rule_attribute", "variant": "declaration", "kind": 1024, @@ -30720,38 +39336,10 @@ "type": "intrinsic", "name": "string" } - } - ], - "groups": [ + }, { - "title": "Properties", - "children": [ - 1521, - 1518, - 1519, - 1520 - ] - } - ] - }, - { - "id": 1639, - "name": "SetPriceListRulesDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The rules to add to a price list." - } - ] - }, - "children": [ - { - "id": 1640, - "name": "priceListId", + "id": 2110, + "name": "default_priority", "variant": "declaration", "kind": 1024, "flags": {}, @@ -30759,67 +39347,13 @@ "summary": [ { "kind": "text", - "text": "The ID of the price list to add rules to." + "text": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy \nthe provided context. The higher the value, the higher the priority of the rule type." } ] }, "type": { "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1641, - "name": "rules", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The rules to add to the price list. Each key of the object is a rule type's " - }, - { - "kind": "code", - "text": "`rule_attribute`" - }, - { - "kind": "text", - "text": ", and its value\nis the value(s) of the rule." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - ] - } - ], - "name": "Record", - "package": "typescript" + "name": "number" } } ], @@ -30827,15 +39361,17 @@ { "title": "Properties", "children": [ - 1640, - 1641 + 2107, + 2108, + 2109, + 2110 ] } ] }, { - "id": 1647, - "name": "SharedContext", + "id": 2111, + "name": "CreateRuleTypeDTO", "variant": "declaration", "kind": 256, "flags": {}, @@ -30843,14 +39379,14 @@ "summary": [ { "kind": "text", - "text": "A shared context object that is used to share resources between the application and the module." + "text": "The rule type to create." } ] }, "children": [ { - "id": 1649, - "name": "manager", + "id": 2112, + "name": "id", "variant": "declaration", "kind": 1024, "flags": { @@ -30860,91 +39396,7 @@ "summary": [ { "kind": "text", - "text": "An instance of an entity manager." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - }, - { - "id": 1648, - "name": "transactionManager", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "An instance of a transaction manager." - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", - "qualifiedName": "EntityManager" - }, - "name": "EntityManager", - "package": "typeorm" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1649, - 1648 - ] - } - ] - }, - { - "id": 1300, - "name": "UpdateCurrencyDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data to update in a currency. The " - }, - { - "kind": "code", - "text": "`code`" - }, - { - "kind": "text", - "text": " is used to identify which currency to update." - } - ] - }, - "children": [ - { - "id": 1301, - "name": "code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The code of the currency to update." + "text": "The ID of the rule type." } ] }, @@ -30954,18 +39406,16 @@ } }, { - "id": 1304, + "id": 2113, "name": "name", "variant": "declaration", "kind": 1024, - "flags": { - "isOptional": true - }, + "flags": {}, "comment": { "summary": [ { "kind": "text", - "text": "The name of the currency." + "text": "The display name of the rule type." } ] }, @@ -30975,128 +39425,8 @@ } }, { - "id": 1302, - "name": "symbol", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The symbol of the currency." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1303, - "name": "symbol_native", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The symbol of the currecy in its native form. This is typically the symbol used when displaying a price." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1301, - 1304, - 1302, - 1303 - ] - } - ] - }, - { - "id": 1327, - "name": "UpdateMoneyAmountDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data to update in a money amount. The " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " is used to identify which money amount to update." - } - ] - }, - "children": [ - { - "id": 1330, - "name": "amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price of this money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1329, - "name": "currency_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The code of the currency to associate with the money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1328, - "name": "id", + "id": 2114, + "name": "rule_attribute", "variant": "declaration", "kind": 1024, "flags": {}, @@ -31104,157 +39434,23 @@ "summary": [ { "kind": "text", - "text": "The ID of the money amount to update." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1332, - "name": "max_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The maximum quantity required to be purchased for this money amount to be applied." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1331, - "name": "min_quantity", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The minimum quantity required to be purchased for this money amount to be applied." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1330, - 1329, - 1328, - 1332, - 1331 - ] - } - ] - }, - { - "id": 1577, - "name": "UpdatePriceListDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attributes to update in a price list." - } - ] - }, - "children": [ - { - "id": 1580, - "name": "description", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list's description." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1582, - "name": "ends_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list expires after this date." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null + "text": "The unique name used to later identify the rule_attribute. For example, it can be used in the " }, { - "type": "intrinsic", - "name": "string" + "kind": "code", + "text": "`context`" }, { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 1578, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ + "kind": "text", + "text": " parameter of the " + }, + { + "kind": "code", + "text": "`calculatePrices`" + }, { "kind": "text", - "text": "The ID of the price list to update." + "text": " \nmethod to specify a rule for calculating the price." } ] }, @@ -31264,8 +39460,8 @@ } }, { - "id": 1585, - "name": "rules", + "id": 2115, + "name": "default_priority", "variant": "declaration", "kind": 1024, "flags": { @@ -31275,30 +39471,7 @@ "summary": [ { "kind": "text", - "text": "The rules to be created and associated with the price list." - } - ] - }, - "type": { - "type": "reference", - "target": 1566, - "name": "CreatePriceListRules", - "package": "@medusajs/types" - } - }, - { - "id": 1584, - "name": "rules_count", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The number of rules associated with the price list." + "text": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. \nThe higher the value, the higher the priority of the rule type." } ] }, @@ -31306,753 +39479,22 @@ "type": "intrinsic", "name": "number" } - }, - { - "id": 1581, - "name": "starts_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list is enabled starting from this date." - } - ] - }, - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - }, - { - "id": 1583, - "name": "status", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list's status." - } - ] - }, - "type": { - "type": "reference", - "target": 1538, - "name": "PriceListStatus", - "package": "@medusajs/types" - } - }, - { - "id": 1579, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The price list's title." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ { "title": "Properties", "children": [ - 1580, - 1582, - 1578, - 1585, - 1584, - 1581, - 1583, - 1579 + 2112, + 2113, + 2114, + 2115 ] } ] }, { - "id": 1618, - "name": "UpdatePriceListRuleDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The attributes to update in a price list rule." - } - ] - }, - "children": [ - { - "id": 1619, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the price list rule to update." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1622, - "name": "price_list", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a price list to be associated with the price list rule." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1620, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a price list to be associated with the price list rule." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1623, - "name": "rule_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a rule type or the details of an existing rule type to be associated with the price list rule." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1621, - "name": "rule_type_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a rule type to be associated with the price list rule." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1619, - 1622, - 1620, - 1623, - 1621 - ] - } - ] - }, - { - "id": 1632, - "name": "UpdatePriceListRuleValueDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1633, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1635, - "name": "price_list_rule_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1634, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1633, - 1635, - 1634 - ] - } - ] - }, - { - "id": 1360, - "name": "UpdatePriceRuleDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data to update in a price rule. The " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " is used to identify which money amount to update." - } - ] - }, - "children": [ - { - "id": 1361, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1367, - "name": "price_list_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated price list." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1362, - "name": "price_set_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1366, - "name": "price_set_money_amount_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the associated price set money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1365, - "name": "priority", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The priority of the price rule in comparison to other applicable price rules." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1363, - "name": "rule_type_id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1364, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the price rule." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1361, - 1367, - 1362, - 1366, - 1365, - 1363, - 1364 - ] - } - ] - }, - { - "id": 1443, - "name": "UpdatePriceSetDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data to update in a price set. The " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " is used to identify which price set to update." - } - ] - }, - "children": [ - { - "id": 1444, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "A string indicating the ID of the price set to update." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1444 - ] - } - ] - }, - { - "id": 1461, - "name": "UpdatePriceSetMoneyAmountDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1462, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1465, - "name": "money_amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1309, - "name": "MoneyAmountDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1464, - "name": "price_set", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1385, - "name": "PriceSetDTO", - "package": "@medusajs/types" - } - }, - { - "id": 1463, - "name": "title", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1462, - 1465, - 1464, - 1463 - ] - } - ] - }, - { - "id": 1487, - "name": "UpdatePriceSetMoneyAmountRulesDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The data to update in a price set money amount rule. The " - }, - { - "kind": "code", - "text": "`id`" - }, - { - "kind": "text", - "text": " is used to identify which money amount to update." - } - ] - }, - "children": [ - { - "id": 1488, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of the price set money amount rule to update." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1489, - "name": "price_set_money_amount", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a price set money amount." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1490, - "name": "rule_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The ID of a rule type." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1491, - "name": "value", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The value of the price set money amount rule." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1488, - 1489, - 1490, - 1491 - ] - } - ] - }, - { - "id": 1507, - "name": "UpdatePriceSetRuleTypeDTO", - "variant": "declaration", - "kind": 256, - "flags": {}, - "children": [ - { - "id": 1508, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1509, - "name": "price_set", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1510, - "name": "rule_type", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1508, - 1509, - 1510 - ] - } - ] - }, - { - "id": 1527, + "id": 2116, "name": "UpdateRuleTypeDTO", "variant": "declaration", "kind": 256, @@ -32075,28 +39517,7 @@ }, "children": [ { - "id": 1531, - "name": "default_priority", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type." - } - ] - }, - "type": { - "type": "intrinsic", - "name": "number" - } - }, - { - "id": 1528, + "id": 2117, "name": "id", "variant": "declaration", "kind": 1024, @@ -32115,7 +39536,7 @@ } }, { - "id": 1529, + "id": 2118, "name": "name", "variant": "declaration", "kind": 1024, @@ -32136,7 +39557,7 @@ } }, { - "id": 1530, + "id": 2119, "name": "rule_attribute", "variant": "declaration", "kind": 1024, @@ -32171,38 +39592,377 @@ "type": "intrinsic", "name": "string" } + }, + { + "id": 2120, + "name": "default_priority", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The priority of the rule type. This is useful when calculating the price of a price set, and multiple rules satisfy the provided context. The higher the value, the higher the priority of the rule type." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } } ], "groups": [ { "title": "Properties", "children": [ - 1531, - 1528, - 1529, - 1530 + 2117, + 2118, + 2119, + 2120 ] } ] }, { - "id": 1, - "name": "AddressDTO", + "id": 2121, + "name": "FilterableRuleTypeProps", "variant": "declaration", - "kind": 2097152, + "kind": 256, "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 2, - "name": "__type", + "comment": { + "summary": [ + { + "kind": "text", + "text": "Filters to apply on rule types." + } + ] + }, + "children": [ + { + "id": 2125, + "name": "$and", "variant": "declaration", - "kind": 65536, + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2121, + "name": "FilterableRuleTypeProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2121, + "name": "FilterableRuleTypeProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 2126, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 2121, + "name": "FilterableRuleTypeProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2121, + "name": "FilterableRuleTypeProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 2122, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs to filter rule types by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2123, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The names to filter rule types by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 2124, + "name": "rule_attribute", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rule attributes to filter rule types by." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2125, + 2126, + 2122, + 2123, + 2124 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 2121, + "name": "FilterableRuleTypeProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 2242, + "name": "ProductCategoryTransformOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2243, + "name": "includeDescendantsTree", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2243 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 738, + "name": "RepositoryTransformOptions", + "package": "@medusajs/types" + } + ] + }, + { + "id": 1299, + "name": "PromotionTypes", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 1300, + "name": "ApplicationMethodTypeValues", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "fixed" + }, + { + "type": "literal", + "value": "percentage" + } + ] + } + }, + { + "id": 1301, + "name": "ApplicationMethodTargetTypeValues", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "order" + }, + { + "type": "literal", + "value": "shipping_methods" + }, + { + "type": "literal", + "value": "items" + } + ] + } + }, + { + "id": 1302, + "name": "ApplicationMethodAllocationValues", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "each" + }, + { + "type": "literal", + "value": "across" + } + ] + } + }, + { + "id": 1303, + "name": "ApplicationMethodDTO", + "variant": "declaration", + "kind": 256, "flags": {}, "children": [ { - "id": 4, - "name": "address_1", + "id": 1304, + "name": "id", "variant": "declaration", "kind": 1024, "flags": {}, @@ -32212,8 +39972,53 @@ } }, { - "id": 5, - "name": "address_2", + "id": 1305, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1300, + "name": "ApplicationMethodTypeValues", + "package": "@medusajs/types" + } + }, + { + "id": 1306, + "name": "target_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1301, + "name": "ApplicationMethodTargetTypeValues", + "package": "@medusajs/types" + } + }, + { + "id": 1307, + "name": "allocation", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1302, + "name": "ApplicationMethodAllocationValues", + "package": "@medusajs/types" + } + }, + { + "id": 1308, + "name": "value", "variant": "declaration", "kind": 1024, "flags": { @@ -32222,20 +40027,20 @@ "type": { "type": "union", "types": [ - { - "type": "intrinsic", - "name": "string" - }, { "type": "literal", "value": null + }, + { + "type": "intrinsic", + "name": "string" } ] } }, { - "id": 8, - "name": "city", + "id": 1309, + "name": "max_quantity", "variant": "declaration", "kind": 1024, "flags": { @@ -32244,53 +40049,20 @@ "type": { "type": "union", "types": [ - { - "type": "intrinsic", - "name": "string" - }, { "type": "literal", "value": null + }, + { + "type": "intrinsic", + "name": "number" } ] } }, { - "id": 6, - "name": "company", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 7, - "name": "country_code", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 13, - "name": "created_at", + "id": 1310, + "name": "promotion", "variant": "declaration", "kind": 1024, "flags": { @@ -32305,19 +40077,143 @@ }, { "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" } ] } }, { - "id": 15, - "name": "deleted_at", + "id": 1311, + "name": "target_rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1434, + "name": "PromotionRuleDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1304, + 1305, + 1306, + 1307, + 1308, + 1309, + 1310, + 1311 + ] + } + ] + }, + { + "id": 1312, + "name": "CreateApplicationMethodDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1313, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1300, + "name": "ApplicationMethodTypeValues", + "package": "@medusajs/types" + } + }, + { + "id": 1314, + "name": "target_type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1301, + "name": "ApplicationMethodTargetTypeValues", + "package": "@medusajs/types" + } + }, + { + "id": 1315, + "name": "allocation", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1302, + "name": "ApplicationMethodAllocationValues", + "package": "@medusajs/types" + } + }, + { + "id": 1316, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1317, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 1318, + "name": "promotion", "variant": "declaration", "kind": 1024, "flags": { @@ -32332,36 +40228,466 @@ }, { "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - { - "type": "literal", - "value": null + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" } ] } }, { - "id": 3, + "id": 1319, + "name": "target_rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1440, + "name": "CreatePromotionRuleDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1313, + 1314, + 1315, + 1316, + 1317, + 1318, + 1319 + ] + } + ] + }, + { + "id": 1320, + "name": "UpdateApplicationMethodDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1321, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1322, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1300, + "name": "ApplicationMethodTypeValues", + "package": "@medusajs/types" + } + }, + { + "id": 1323, + "name": "target_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1301, + "name": "ApplicationMethodTargetTypeValues", + "package": "@medusajs/types" + } + }, + { + "id": 1324, + "name": "allocation", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1302, + "name": "ApplicationMethodAllocationValues", + "package": "@medusajs/types" + } + }, + { + "id": 1325, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1326, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 1327, + "name": "promotion", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1321, + 1322, + 1323, + 1324, + 1325, + 1326, + 1327 + ] + } + ] + }, + { + "id": 1328, + "name": "FilterableApplicationMethodProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 1333, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1328, + "name": "FilterableApplicationMethodProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1328, + "name": "FilterableApplicationMethodProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 1334, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1328, + "name": "FilterableApplicationMethodProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1328, + "name": "FilterableApplicationMethodProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 1329, "name": "id", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1330, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1300, + "name": "ApplicationMethodTypeValues", + "package": "@medusajs/types" + } + } + }, + { + "id": 1331, + "name": "target_type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1301, + "name": "ApplicationMethodTargetTypeValues", + "package": "@medusajs/types" + } + } + }, + { + "id": 1332, + "name": "allocation", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1302, + "name": "ApplicationMethodAllocationValues", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1333, + 1334, + 1329, + 1330, + 1331, + 1332 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1328, + "name": "FilterableApplicationMethodProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 1349, + "name": "CampaignBudgetTypeValues", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "spend" + }, + { + "type": "literal", + "value": "usage" + } + ] + } + }, + { + "id": 1350, + "name": "CampaignBudgetDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1351, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, "type": { "type": "intrinsic", "name": "string" } }, { - "id": 12, - "name": "metadata", + "id": 1352, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1349, + "name": "CampaignBudgetTypeValues", + "package": "@medusajs/types" + } + }, + { + "id": 1353, + "name": "limit", "variant": "declaration", "kind": 1024, "flags": { @@ -32370,6 +40696,5080 @@ "type": { "type": "union", "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 1354, + "name": "used", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1351, + 1352, + 1353, + 1354 + ] + } + ] + }, + { + "id": 1355, + "name": "FilterableCampaignBudgetProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 1358, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1355, + "name": "FilterableCampaignBudgetProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1355, + "name": "FilterableCampaignBudgetProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 1359, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1355, + "name": "FilterableCampaignBudgetProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1355, + "name": "FilterableCampaignBudgetProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 1356, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1357, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1358, + 1359, + 1356, + 1357 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1355, + "name": "FilterableCampaignBudgetProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 1335, + "name": "CampaignDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1336, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1337, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1338, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1339, + "name": "currency", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1340, + "name": "campaign_identifier", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1341, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1342, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1343, + "name": "budget", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1350, + "name": "CampaignBudgetDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1336, + 1337, + 1338, + 1339, + 1340, + 1341, + 1342, + 1343 + ] + } + ] + }, + { + "id": 1344, + "name": "FilterableCampaignProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 1347, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1344, + "name": "FilterableCampaignProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1344, + "name": "FilterableCampaignProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 1348, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1344, + "name": "FilterableCampaignProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1344, + "name": "FilterableCampaignProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 1345, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1346, + "name": "campaign_identifier", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1347, + 1348, + 1345, + 1346 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1344, + "name": "FilterableCampaignProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 1360, + "name": "ComputeActions", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1365, + "name": "AddItemAdjustmentAction", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 1371, + "name": "RemoveItemAdjustmentAction", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 1376, + "name": "AddShippingMethodAdjustment", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 1382, + "name": "RemoveShippingMethodAdjustment", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 1362, + "name": "CampaignBudgetExceededAction", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 1361, + "name": "UsageComputedActions", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1376, + "name": "AddShippingMethodAdjustment", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 1365, + "name": "AddItemAdjustmentAction", + "package": "@medusajs/types" + } + ] + } + }, + { + "id": 1362, + "name": "CampaignBudgetExceededAction", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1363, + "name": "action", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "literal", + "value": "campaignBudgetExceeded" + } + }, + { + "id": 1364, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1363, + 1364 + ] + } + ] + }, + { + "id": 1365, + "name": "AddItemAdjustmentAction", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1366, + "name": "action", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "literal", + "value": "addItemAdjustment" + } + }, + { + "id": 1367, + "name": "item_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1368, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1369, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1370, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1366, + 1367, + 1368, + 1369, + 1370 + ] + } + ] + }, + { + "id": 1371, + "name": "RemoveItemAdjustmentAction", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1372, + "name": "action", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "literal", + "value": "removeItemAdjustment" + } + }, + { + "id": 1373, + "name": "adjustment_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1374, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1375, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1372, + 1373, + 1374, + 1375 + ] + } + ] + }, + { + "id": 1376, + "name": "AddShippingMethodAdjustment", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1377, + "name": "action", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "literal", + "value": "addShippingMethodAdjustment" + } + }, + { + "id": 1378, + "name": "shipping_method_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1379, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1380, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1381, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1377, + 1378, + 1379, + 1380, + 1381 + ] + } + ] + }, + { + "id": 1382, + "name": "RemoveShippingMethodAdjustment", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1383, + "name": "action", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "literal", + "value": "removeShippingMethodAdjustment" + } + }, + { + "id": 1384, + "name": "adjustment_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1385, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1383, + 1384, + 1385 + ] + } + ] + }, + { + "id": 1386, + "name": "ComputeActionAdjustmentLine", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1387, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1388, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1387, + 1388 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + }, + { + "id": 1389, + "name": "ComputeActionItemLine", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1390, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1391, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1392, + "name": "unit_price", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1393, + "name": "adjustments", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1386, + "name": "ComputeActionAdjustmentLine", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1390, + 1391, + 1392, + 1393 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + }, + { + "id": 1394, + "name": "ComputeActionShippingLine", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1395, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1396, + "name": "unit_price", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1397, + "name": "adjustments", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1386, + "name": "ComputeActionAdjustmentLine", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1395, + 1396, + 1397 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + }, + { + "id": 1398, + "name": "ComputeActionContext", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1399, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1389, + "name": "ComputeActionItemLine", + "package": "@medusajs/types" + } + } + }, + { + "id": 1400, + "name": "shipping_methods", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1394, + "name": "ComputeActionShippingLine", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1399, + 1400 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + ] + }, + { + "id": 1454, + "name": "PromotionRuleValueDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1455, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1456, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1455, + 1456 + ] + } + ] + }, + { + "id": 1457, + "name": "CreatePromotionRuleValueDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1458, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1459, + "name": "promotion_rule", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1434, + "name": "PromotionRuleDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1458, + 1459 + ] + } + ] + }, + { + "id": 1460, + "name": "UpdatePromotionRuleValueDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1461, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1461 + ] + } + ] + }, + { + "id": 1462, + "name": "FilterablePromotionRuleValueProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 1464, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1462, + "name": "FilterablePromotionRuleValueProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1462, + "name": "FilterablePromotionRuleValueProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 1465, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1462, + "name": "FilterablePromotionRuleValueProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1462, + "name": "FilterablePromotionRuleValueProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 1463, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1464, + 1465, + 1463 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1462, + "name": "FilterablePromotionRuleValueProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 1433, + "name": "PromotionRuleOperatorValues", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "gt" + }, + { + "type": "literal", + "value": "lt" + }, + { + "type": "literal", + "value": "eq" + }, + { + "type": "literal", + "value": "ne" + }, + { + "type": "literal", + "value": "in" + }, + { + "type": "literal", + "value": "lte" + }, + { + "type": "literal", + "value": "gte" + } + ] + } + }, + { + "id": 1434, + "name": "PromotionRuleDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1435, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1436, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1437, + "name": "attribute", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1438, + "name": "operator", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1433, + "name": "PromotionRuleOperatorValues", + "package": "@medusajs/types" + } + }, + { + "id": 1439, + "name": "values", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1454, + "name": "PromotionRuleValueDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1435, + 1436, + 1437, + 1438, + 1439 + ] + } + ] + }, + { + "id": 1440, + "name": "CreatePromotionRuleDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1441, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1442, + "name": "attribute", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1443, + "name": "operator", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1433, + "name": "PromotionRuleOperatorValues", + "package": "@medusajs/types" + } + }, + { + "id": 1444, + "name": "values", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1441, + 1442, + 1443, + 1444 + ] + } + ] + }, + { + "id": 1445, + "name": "UpdatePromotionRuleDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1446, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1446 + ] + } + ] + }, + { + "id": 1447, + "name": "RemovePromotionRuleDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1448, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1448 + ] + } + ] + }, + { + "id": 1449, + "name": "FilterablePromotionRuleProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 1452, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1449, + "name": "FilterablePromotionRuleProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1449, + "name": "FilterablePromotionRuleProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 1453, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1449, + "name": "FilterablePromotionRuleProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1449, + "name": "FilterablePromotionRuleProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 1450, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1451, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1452, + 1453, + 1450, + 1451 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1449, + "name": "FilterablePromotionRuleProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 1401, + "name": "PromotionType", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": "standard" + }, + { + "type": "literal", + "value": "buyget" + } + ] + } + }, + { + "id": 1402, + "name": "PromotionDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1403, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1404, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1405, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1401, + "name": "PromotionType", + "package": "@medusajs/types" + } + }, + { + "id": 1406, + "name": "is_automatic", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1407, + "name": "application_method", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1303, + "name": "ApplicationMethodDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1408, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1434, + "name": "PromotionRuleDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1409, + "name": "campaign", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1335, + "name": "CampaignDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1403, + 1404, + 1405, + 1406, + 1407, + 1408, + 1409 + ] + } + ] + }, + { + "id": 1410, + "name": "CreatePromotionDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1411, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1412, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1401, + "name": "PromotionType", + "package": "@medusajs/types" + } + }, + { + "id": 1413, + "name": "is_automatic", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1414, + "name": "application_method", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1312, + "name": "CreateApplicationMethodDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1415, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1440, + "name": "CreatePromotionRuleDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1416, + "name": "campaign", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1475, + "name": "CreateCampaignDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1417, + "name": "campaign_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1411, + 1412, + 1413, + 1414, + 1415, + 1416, + 1417 + ] + } + ] + }, + { + "id": 1418, + "name": "UpdatePromotionDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1419, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1420, + "name": "is_automatic", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1421, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1422, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1401, + "name": "PromotionType", + "package": "@medusajs/types" + } + }, + { + "id": 1423, + "name": "application_method", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1320, + "name": "UpdateApplicationMethodDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1424, + "name": "campaign_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1419, + 1420, + 1421, + 1422, + 1423, + 1424 + ] + } + ] + }, + { + "id": 1425, + "name": "FilterablePromotionProps", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object used to allow specifying flexible queries with and/or conditions." + } + ] + }, + "children": [ + { + "id": 1431, + "name": "$and", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1425, + "name": "FilterablePromotionProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1425, + "name": "FilterablePromotionProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 867, + "name": "BaseFilterable.$and" + } + }, + { + "id": 1432, + "name": "$or", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": 1425, + "name": "FilterablePromotionProps", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1425, + "name": "FilterablePromotionProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 868, + "name": "BaseFilterable.$or" + } + }, + { + "id": 1426, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1427, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1428, + "name": "is_automatic", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1429, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1401, + "name": "PromotionType", + "package": "@medusajs/types" + } + } + }, + { + "id": 1430, + "name": "budget_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1431, + 1432, + 1426, + 1427, + 1428, + 1429, + 1430 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 866, + "typeArguments": [ + { + "type": "reference", + "target": 1425, + "name": "FilterablePromotionProps", + "package": "@medusajs/types" + } + ], + "name": "BaseFilterable", + "package": "@medusajs/types" + } + ] + }, + { + "id": 1466, + "name": "CreateCampaignBudgetDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1467, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1349, + "name": "CampaignBudgetTypeValues", + "package": "@medusajs/types" + } + }, + { + "id": 1468, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 1469, + "name": "used", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1467, + 1468, + 1469 + ] + } + ] + }, + { + "id": 1470, + "name": "UpdateCampaignBudgetDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1471, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1472, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1349, + "name": "CampaignBudgetTypeValues", + "package": "@medusajs/types" + } + }, + { + "id": 1473, + "name": "limit", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 1474, + "name": "used", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1471, + 1472, + 1473, + 1474 + ] + } + ] + }, + { + "id": 1475, + "name": "CreateCampaignDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1476, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1477, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1478, + "name": "currency", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1479, + "name": "campaign_identifier", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1480, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1481, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1482, + "name": "budget", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1466, + "name": "CreateCampaignBudgetDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1483, + "name": "promotions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Pick" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + }, + { + "type": "literal", + "value": "id" + } + ], + "name": "Pick", + "package": "typescript" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1476, + 1477, + 1478, + 1479, + 1480, + 1481, + 1482, + 1483 + ] + } + ] + }, + { + "id": 1484, + "name": "UpdateCampaignDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1485, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1486, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1487, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1488, + "name": "currency", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1489, + "name": "campaign_identifier", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1490, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1491, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1492, + "name": "budget", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Omit" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1470, + "name": "UpdateCampaignBudgetDTO", + "package": "@medusajs/types" + }, + { + "type": "literal", + "value": "id" + } + ], + "name": "Omit", + "package": "typescript" + } + }, + { + "id": 1493, + "name": "promotions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Pick" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + }, + { + "type": "literal", + "value": "id" + } + ], + "name": "Pick", + "package": "typescript" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1485, + 1486, + 1487, + 1488, + 1489, + 1490, + 1491, + 1492, + 1493 + ] + } + ] + }, + { + "id": 1494, + "name": "IPromotionModuleService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1585, + "name": "__joinerConfig", + "variant": "declaration", + "kind": 2048, + "flags": { + "isOptional": true + }, + "signatures": [ + { + "id": 1586, + "name": "__joinerConfig", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reference", + "target": 1219, + "name": "ModuleJoinerConfig", + "package": "@medusajs/types" + }, + "inheritedFrom": { + "type": "reference", + "target": 1293, + "name": "IModuleService.__joinerConfig" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": 1292, + "name": "IModuleService.__joinerConfig" + } + }, + { + "id": 1587, + "name": "__hooks", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1588, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1589, + "name": "onApplicationStart", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1590, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1591, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1589 + ] + } + ] + } + }, + "inheritedFrom": { + "type": "reference", + "target": 1294, + "name": "IModuleService.__hooks" + } + }, + { + "id": 1495, + "name": "registerUsage", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1496, + "name": "registerUsage", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1497, + "name": "computedActions", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1360, + "name": "ComputeActions", + "package": "@medusajs/types" + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1498, + "name": "computeActions", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1499, + "name": "computeActions", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1500, + "name": "promotionCodesToApply", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1501, + "name": "applicationContext", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1398, + "name": "ComputeActionContext", + "package": "@medusajs/types" + } + }, + { + "id": 1502, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "any" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 1360, + "name": "ComputeActions", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1503, + "name": "create", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1504, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1505, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1410, + "name": "CreatePromotionDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1506, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 1507, + "name": "create", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1508, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1410, + "name": "CreatePromotionDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1509, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1510, + "name": "update", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1511, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1512, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1418, + "name": "UpdatePromotionDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1513, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 1514, + "name": "update", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1515, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1418, + "name": "UpdatePromotionDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1516, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1517, + "name": "list", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1518, + "name": "list", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1519, + "name": "filters", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1425, + "name": "FilterablePromotionProps", + "package": "@medusajs/types" + } + }, + { + "id": 1520, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 1521, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1522, + "name": "retrieve", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1523, + "name": "retrieve", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1524, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1525, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 1526, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1527, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1528, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1529, + "name": "ids", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1530, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 1531, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1532, + "name": "ids", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1533, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1534, + "name": "addPromotionRules", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1535, + "name": "addPromotionRules", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1536, + "name": "promotionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1537, + "name": "rulesData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1440, + "name": "CreatePromotionRuleDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1538, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1539, + "name": "addPromotionTargetRules", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1540, + "name": "addPromotionTargetRules", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1541, + "name": "promotionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1542, + "name": "rulesData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1440, + "name": "CreatePromotionRuleDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1543, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1544, + "name": "removePromotionRules", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1545, + "name": "removePromotionRules", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1546, + "name": "promotionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1547, + "name": "rulesData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1447, + "name": "RemovePromotionRuleDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1548, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1549, + "name": "removePromotionTargetRules", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1550, + "name": "removePromotionTargetRules", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1551, + "name": "promotionId", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1552, + "name": "rulesData", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1447, + "name": "RemovePromotionRuleDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1553, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1402, + "name": "PromotionDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1554, + "name": "createCampaigns", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1555, + "name": "createCampaigns", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1556, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1475, + "name": "CreateCampaignDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1557, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1335, + "name": "CampaignDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 1558, + "name": "createCampaigns", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1559, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1475, + "name": "CreateCampaignDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1560, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 1335, + "name": "CampaignDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1561, + "name": "updateCampaigns", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1562, + "name": "updateCampaigns", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1563, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1484, + "name": "UpdateCampaignDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1564, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 1335, + "name": "CampaignDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 1565, + "name": "updateCampaigns", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1566, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 1484, + "name": "UpdateCampaignDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1567, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1335, + "name": "CampaignDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1568, + "name": "listCampaigns", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1569, + "name": "listCampaigns", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1570, + "name": "filters", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1344, + "name": "FilterableCampaignProps", + "package": "@medusajs/types" + } + }, + { + "id": 1571, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 1335, + "name": "CampaignDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 1572, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": 1335, + "name": "CampaignDTO", + "package": "@medusajs/types" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1573, + "name": "retrieveCampaign", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1574, + "name": "retrieveCampaign", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1575, + "name": "id", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1576, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 672, + "typeArguments": [ + { + "type": "reference", + "target": 1335, + "name": "CampaignDTO", + "package": "@medusajs/types" + } + ], + "name": "FindConfig", + "package": "@medusajs/types" + } + }, + { + "id": 1577, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1335, + "name": "CampaignDTO", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 1578, + "name": "deleteCampaigns", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1579, + "name": "deleteCampaigns", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1580, + "name": "ids", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1581, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + }, + { + "id": 1582, + "name": "deleteCampaigns", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1583, + "name": "ids", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1584, + "name": "sharedContext", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2247, + "name": "Context", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1587 + ] + }, + { + "title": "Methods", + "children": [ + 1585, + 1495, + 1498, + 1503, + 1510, + 1517, + 1522, + 1527, + 1534, + 1539, + 1544, + 1549, + 1554, + 1561, + 1568, + 1573, + 1578 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": 1291, + "name": "IModuleService", + "package": "@medusajs/types" + } + ] + } + ], + "groups": [ + { + "title": "Interfaces", + "children": [ + 1303, + 1312, + 1320, + 1328, + 1350, + 1355, + 1335, + 1344, + 1362, + 1365, + 1371, + 1376, + 1382, + 1386, + 1389, + 1394, + 1398, + 1454, + 1457, + 1460, + 1462, + 1434, + 1440, + 1445, + 1447, + 1449, + 1402, + 1410, + 1418, + 1425, + 1466, + 1470, + 1475, + 1484, + 1494 + ] + }, + { + "title": "Type Aliases", + "children": [ + 1300, + 1301, + 1302, + 1349, + 1360, + 1361, + 1433, + 1401 + ] + } + ] + }, + { + "id": 1592, + "name": "RegionTypes", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 1593, + "name": "RegionDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 1594, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1595, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1596, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1597, + "name": "tax_rate", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1598, + "name": "tax_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 1599, + "name": "gift_cards_taxable", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1600, + "name": "automatic_taxes", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1601, + "name": "tax_provider_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 1602, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1603, + "name": "includes_tax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1595, + 1596, + 1597, + 1598, + 1599, + 1600, + 1601, + 1602, + 1603 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Type Aliases", + "children": [ + 1593 + ] + } + ] + }, + { + "id": 1604, + "name": "SalesChannelTypes", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 1605, + "name": "SalesChannelLocationDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1606, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1607, + "name": "location_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1608, + "name": "sales_channel", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": 1609, + "name": "SalesChannelDTO", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1606, + 1607, + 1608 + ] + } + ] + }, + { + "id": 1609, + "name": "SalesChannelDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1610, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1611, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1612, + "name": "is_disabled", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 1613, + "name": "metadata", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, { "type": "reference", "target": { @@ -32388,1387 +45788,13 @@ ], "name": "Record", "package": "typescript" - }, - { - "type": "literal", - "value": null } ] } }, { - "id": 9, - "name": "phone", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 10, - "name": "postal_code", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 11, - "name": "province", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 14, - "name": "updated_at", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - } - ] - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 4, - 5, - 8, - 6, - 7, - 13, - 15, - 3, - 12, - 9, - 10, - 11, - 14 - ] - } - ] - } - } - }, - { - "id": 115, - "name": "AuthProviderDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 116, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 119, - "name": "domain", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 133, - "name": "ProviderDomain", - "package": "@medusajs/types" - } - }, - { - "id": 120, - "name": "is_active", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 118, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 117, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 119, - 120, - 118, - 117 - ] - } - ] - } - } - }, - { - "id": 90, - "name": "AuthUserDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 91, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 97, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 92, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 94, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": 115, - "name": "AuthProviderDTO", - "package": "@medusajs/types" - } - }, - { - "id": 93, - "name": "provider_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 95, - "name": "provider_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 96, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 97, - 92, - 94, - 93, - 95, - 96 - ] - } - ] - } - } - }, - { - "id": 121, - "name": "CreateAuthProviderDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 122, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 125, - "name": "domain", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 133, - "name": "ProviderDomain", - "package": "@medusajs/types" - } - }, - { - "id": 126, - "name": "is_active", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 124, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 123, - "name": "provider", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 125, - 126, - 124, - 123 - ] - } - ] - } - } - }, - { - "id": 98, - "name": "CreateAuthUserDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 99, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 103, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 100, - "name": "provider_id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 101, - "name": "provider_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 102, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 103, - 100, - 101, - 102 - ] - } - ] - } - } - }, - { - "id": 1175, - "name": "DeleteFileType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1176, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1177, - "name": "fileKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1177 - ] - } - ], - "indexSignature": { - "id": 1178, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 1179, - "name": "x", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - } - } - }, - { - "id": 1690, - "name": "Dictionary", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 1694, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {}, - "default": { - "type": "intrinsic", - "name": "any" - } - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1691, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "indexSignature": { - "id": 1692, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 1693, - "name": "k", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "reference", - "target": 1694, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - } - } - }, - { - "id": 1730, - "name": "ExpandScalar", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 1731, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "literal", - "value": null - }, - { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1731, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "string" - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "RegExp" - }, - "name": "RegExp", - "package": "typescript" - } - ] - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1731, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - "trueType": { - "type": "union", - "types": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "falseType": { - "type": "reference", - "target": 1731, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - } - ] - } - }, - { - "id": 1161, - "name": "FileServiceGetUploadStreamResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1162, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1166, - "name": "fileKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1164, - "name": "promise", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Promise" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Promise", - "package": "typescript" - } - }, - { - "id": 1165, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1163, - "name": "writeStream", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/@types/node/stream.d.ts", - "qualifiedName": "internal.PassThrough" - }, - "name": "stream.PassThrough", - "package": "@types/node", - "qualifiedName": "internal.PassThrough" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1166, - 1164, - 1165, - 1163 - ] - } - ], - "indexSignature": { - "id": 1167, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 1168, - "name": "x", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - } - } - }, - { - "id": 1157, - "name": "FileServiceUploadResult", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1158, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1160, - "name": "key", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1159, - "name": "url", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1160, - 1159 - ] - } - ] - } - } - }, - { - "id": 1736, - "name": "FilterValue", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 1737, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1665, - "typeArguments": [ - { - "type": "reference", - "target": 1738, - "typeArguments": [ - { - "type": "reference", - "target": 1737, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "FilterValue2", - "package": "@medusajs/types" - } - ], - "name": "OperatorMap", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 1738, - "typeArguments": [ - { - "type": "reference", - "target": 1737, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "FilterValue2", - "package": "@medusajs/types" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1738, - "typeArguments": [ - { - "type": "reference", - "target": 1737, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "FilterValue2", - "package": "@medusajs/types" - } - }, - { - "type": "literal", - "value": null - } - ] - } - }, - { - "id": 1738, - "name": "FilterValue2", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 1739, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1739, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - { - "type": "reference", - "target": 1730, - "typeArguments": [ - { - "type": "reference", - "target": 1739, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ExpandScalar", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 1740, - "typeArguments": [ - { - "type": "reference", - "target": 1739, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "Primary", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 1169, - "name": "GetUploadedFileType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1170, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1171, - "name": "fileKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1172, - "name": "isPrivate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1171, - 1172 - ] - } - ], - "indexSignature": { - "id": 1173, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 1174, - "name": "x", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" - } - } - } - } - }, - { - "id": 1187, - "name": "JoinerRelationship", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1188, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1189, - "name": "alias", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1196, - "name": "args", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Extra arguments to pass to the remoteFetchData callback" - } - ] - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "any" - } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 1190, - "name": "foreignKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1194, - "name": "inverse", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "In an inverted relationship the foreign key is on the other service and the primary key is on the current service" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1193, - "name": "isInternalService", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1195, - "name": "isList", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "comment": { - "summary": [ - { - "kind": "text", - "text": "Force the relationship to return a list" - } - ] - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1191, - "name": "primaryKey", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1192, - "name": "serviceName", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1189, - 1196, - 1190, - 1194, - 1193, - 1195, - 1191, - 1192 - ] - } - ] - } - } - }, - { - "id": 1720, - "name": "ModuleDeclaration", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 708, - "name": "ExternalModuleDeclaration", - "package": "@medusajs/types" - }, - { - "type": "reference", - "target": 698, - "name": "InternalModuleDeclaration", - "package": "@medusajs/types" - } - ] - } - }, - { - "id": 1665, - "name": "OperatorMap", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 1686, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "reflection", - "declaration": { - "id": 1666, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1667, - "name": "$and", + "id": 1614, + "name": "locations", "variant": "declaration", "kind": 1024, "flags": { @@ -33778,698 +45804,181 @@ "type": "array", "elementType": { "type": "reference", - "target": 1728, - "typeArguments": [ - { - "type": "reference", - "target": 1686, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "Query", + "target": 1605, + "name": "SalesChannelLocationDTO", "package": "@medusajs/types" } } - }, - { - "id": 1684, - "name": "$contained", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1683, - "name": "$contains", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1669, - "name": "$eq", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "union", - "types": [ - { - "type": "reference", - "target": 1730, - "typeArguments": [ - { - "type": "reference", - "target": 1686, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ExpandScalar", - "package": "@medusajs/types" - }, - { - "type": "array", - "elementType": { - "type": "reference", - "target": 1730, - "typeArguments": [ - { - "type": "reference", - "target": 1686, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ExpandScalar", - "package": "@medusajs/types" - } - } - ] - } - }, - { - "id": 1685, - "name": "$exists", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1681, - "name": "$fulltext", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1674, - "name": "$gt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1730, - "typeArguments": [ - { - "type": "reference", - "target": 1686, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ExpandScalar", - "package": "@medusajs/types" - } - }, - { - "id": 1675, - "name": "$gte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1730, - "typeArguments": [ - { - "type": "reference", - "target": 1686, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ExpandScalar", - "package": "@medusajs/types" - } - }, - { - "id": 1680, - "name": "$ilike", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1671, - "name": "$in", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1730, - "typeArguments": [ - { - "type": "reference", - "target": 1686, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ExpandScalar", - "package": "@medusajs/types" - } - } - }, - { - "id": 1678, - "name": "$like", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1676, - "name": "$lt", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1730, - "typeArguments": [ - { - "type": "reference", - "target": 1686, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ExpandScalar", - "package": "@medusajs/types" - } - }, - { - "id": 1677, - "name": "$lte", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1730, - "typeArguments": [ - { - "type": "reference", - "target": 1686, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ExpandScalar", - "package": "@medusajs/types" - } - }, - { - "id": 1670, - "name": "$ne", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1730, - "typeArguments": [ - { - "type": "reference", - "target": 1686, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ExpandScalar", - "package": "@medusajs/types" - } - }, - { - "id": 1672, - "name": "$nin", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1730, - "typeArguments": [ - { - "type": "reference", - "target": 1686, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ExpandScalar", - "package": "@medusajs/types" - } - } - }, - { - "id": 1673, - "name": "$not", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 1728, - "typeArguments": [ - { - "type": "reference", - "target": 1686, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "Query", - "package": "@medusajs/types" - } - }, - { - "id": 1668, - "name": "$or", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "reference", - "target": 1728, - "typeArguments": [ - { - "type": "reference", - "target": 1686, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "Query", - "package": "@medusajs/types" - } - } - }, - { - "id": 1682, - "name": "$overlap", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "string" - } - } - }, - { - "id": 1679, - "name": "$re", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } } ], "groups": [ { "title": "Properties", "children": [ - 1667, - 1684, - 1683, - 1669, - 1685, - 1681, - 1674, - 1675, - 1680, - 1671, - 1678, - 1676, - 1677, - 1670, - 1672, - 1673, - 1668, - 1682, - 1679 + 1610, + 1611, + 1612, + 1613, + 1614 ] } ] } - } - }, - { - "id": 1688, - "name": "Order", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 1689, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } ], - "type": { - "type": "mapped", - "parameter": "key", - "parameterType": { - "type": "typeOperator", - "operator": "keyof", - "target": { - "type": "reference", - "target": 1689, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - }, - "templateType": { - "type": "union", - "types": [ - { - "type": "literal", - "value": "ASC" - }, - { - "type": "literal", - "value": "DESC" - }, - { - "type": "reference", - "target": 1688, - "typeArguments": [ - { - "type": "conditional", - "checkType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "key" - }, - "name": "key", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 1689, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - }, - "trueType": { - "type": "indexedAccess", - "indexType": { - "type": "literal", - "value": 0 - }, - "objectType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "key" - }, - "name": "key", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 1689, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - }, - "falseType": { - "type": "indexedAccess", - "indexType": { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "key" - }, - "name": "key", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "objectType": { - "type": "reference", - "target": 1689, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - } - ], - "name": "Order", - "package": "@medusajs/types" - } + "groups": [ + { + "title": "Interfaces", + "children": [ + 1605, + 1609 ] - }, - "optionalModifier": "+" - } - }, - { - "id": 1687, - "name": "PrevLimit", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "tuple", - "elements": [ - { - "type": "intrinsic", - "name": "never" - }, - { - "type": "literal", - "value": 1 - }, - { - "type": "literal", - "value": 2 - }, - { - "type": "literal", - "value": 3 - } - ] - } - }, - { - "id": 1740, - "name": "Primary", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 1749, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1749, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 1741, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1742, - "name": "[PrimaryKeyType]", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "inferred", - "name": "PK" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1742 - ] - } - ] - } - }, - "trueType": { - "type": "reference", - "target": 1750, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "PK" - }, - "name": "PK", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ReadonlyPrimary", - "package": "@medusajs/types" - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1749, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "extendsType": { + ] + }, + { + "id": 1615, + "name": "SearchTypes", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 1616, + "name": "IndexSettings", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { "type": "reflection", "declaration": { - "id": 1743, + "id": 1617, "name": "__type", "variant": "declaration", "kind": 65536, "flags": {}, "children": [ { - "id": 1744, - "name": "_id", + "id": 1618, + "name": "indexSettings", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Settings specific to the provider. E.g. " + }, + { + "kind": "code", + "text": "`searchableAttributes`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 1619, + "name": "primaryKey", "variant": "declaration", "kind": 1024, "flags": { "isOptional": true }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Primary key for the index. Used to enforce unique documents in an index. See more in Meilisearch' https://docs.meilisearch.com/learn/core_concepts/primary_key.html." + } + ] + }, "type": { - "type": "inferred", - "name": "PK" + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1620, + "name": "transformer", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Document transformer. Used to transform documents before they are added to the index." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 1621, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 1622, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Document transformer. Used to transform documents before they are added to the index." + } + ] + }, + "parameters": [ + { + "id": 1623, + "name": "document", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "intrinsic", + "name": "any" + } + } + ] + } } } ], @@ -34477,812 +45986,2692 @@ { "title": "Properties", "children": [ - 1744 + 1618, + 1619, + 1620 ] } ] } - }, - "trueType": { - "type": "union", - "types": [ - { + } + }, + { + "id": 1624, + "name": "ISearchService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1625, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { "type": "reference", - "target": 1750, + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, "typeArguments": [ { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "PK" - }, - "name": "PK", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ReadonlyPrimary", - "package": "@medusajs/types" - }, - { - "type": "intrinsic", - "name": "string" - } - ] - }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1749, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 1745, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1746, - "name": "uuid", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "inferred", - "name": "PK" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1746 - ] - } - ] - } - }, - "trueType": { - "type": "reference", - "target": 1750, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "PK" + "type": "intrinsic", + "name": "string" }, - "name": "PK", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "ReadonlyPrimary", - "package": "@medusajs/types" + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } }, - "falseType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1749, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reflection", - "declaration": { - "id": 1747, - "name": "__type", - "variant": "declaration", - "kind": 65536, + { + "id": 1626, + "name": "createIndex", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1627, + "name": "createIndex", + "variant": "signature", + "kind": 4096, "flags": {}, - "children": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to create an index" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "returns response from search engine provider" + } + ] + } + ] + }, + "parameters": [ { - "id": 1748, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true + "id": 1628, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the index name" + } + ] }, "type": { - "type": "inferred", - "name": "PK" + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1629, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the options" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" } } ], - "groups": [ - { - "title": "Properties", - "children": [ - 1748 - ] - } - ] - } - }, - "trueType": { - "type": "reference", - "target": 1750, - "typeArguments": [ - { - "type": "reference", - "target": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "PK" - }, - "name": "PK", - "package": "@medusajs/types", - "refersToTypeParameter": true + "type": { + "type": "intrinsic", + "name": "unknown" } - ], - "name": "ReadonlyPrimary", - "package": "@medusajs/types" - }, - "falseType": { - "type": "intrinsic", - "name": "never" - } - } - } - } - } - }, - { - "id": 1728, - "name": "Query", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 1729, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1729, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "intrinsic", - "name": "object" - }, - "trueType": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1729, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "reference", - "target": 1732, - "name": "Scalar", - "package": "@medusajs/types" - }, - "trueType": { - "type": "intrinsic", - "name": "never" - }, - "falseType": { - "type": "reference", - "target": 412, - "typeArguments": [ - { - "type": "reference", - "target": 1729, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "FilterQuery", - "package": "@medusajs/types" - } - }, - "falseType": { - "type": "reference", - "target": 1736, - "typeArguments": [ + } + ] + }, { - "type": "reference", - "target": 1729, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "FilterValue", - "package": "@medusajs/types" - } - } - }, - { - "id": 1750, - "name": "ReadonlyPrimary", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "typeParameters": [ - { - "id": 1751, - "name": "T", - "variant": "typeParam", - "kind": 131072, - "flags": {} - } - ], - "type": { - "type": "conditional", - "checkType": { - "type": "reference", - "target": 1751, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - }, - "extendsType": { - "type": "array", - "elementType": { - "type": "intrinsic", - "name": "any" - } - }, - "trueType": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Readonly" - }, - "typeArguments": [ - { - "type": "reference", - "target": 1751, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - ], - "name": "Readonly", - "package": "typescript" - }, - "falseType": { - "type": "reference", - "target": 1751, - "name": "T", - "package": "@medusajs/types", - "refersToTypeParameter": true - } - } - }, - { - "id": 1732, - "name": "Scalar", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "union", - "types": [ - { - "type": "intrinsic", - "name": "boolean" - }, - { - "type": "intrinsic", - "name": "number" - }, - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "bigint" - }, - { - "type": "intrinsic", - "name": "symbol" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Date" - }, - "name": "Date", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "RegExp" - }, - "name": "RegExp", - "package": "typescript" - }, - { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/@types/node/buffer.d.ts", - "qualifiedName": "__global.Buffer" - }, - "name": "Buffer", - "package": "@types/node", - "qualifiedName": "__global.Buffer" - }, - { - "type": "reflection", - "declaration": { - "id": 1733, - "name": "__type", + "id": 1630, + "name": "getIndex", "variant": "declaration", - "kind": 65536, + "kind": 2048, "flags": {}, - "children": [ + "signatures": [ { - "id": 1734, - "name": "toHexString", - "variant": "declaration", - "kind": 2048, + "id": 1631, + "name": "getIndex", + "variant": "signature", + "kind": 4096, "flags": {}, - "signatures": [ + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to get an index" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "returns response from search engine provider" + } + ] + } + ] + }, + "parameters": [ { - "id": 1735, - "name": "toHexString", - "variant": "signature", - "kind": 4096, + "id": 1632, + "name": "indexName", + "variant": "param", + "kind": 32768, "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the index name." + } + ] + }, "type": { "type": "intrinsic", "name": "string" } } - ] + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ] + }, + { + "id": 1633, + "name": "addDocuments", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1634, + "name": "addDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to index documents by the search engine provider" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "returns response from search engine provider" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1635, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the index name" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1636, + "name": "documents", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "documents array to be indexed" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 1637, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "of documents to be added (e.g: products, regions, orders, etc)" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ] + }, + { + "id": 1638, + "name": "replaceDocuments", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1639, + "name": "replaceDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to replace documents" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "returns response from search engine provider" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1640, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the index name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1641, + "name": "documents", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "array of document objects that will replace existing documents" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 1642, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "type of documents to be replaced (e.g: products, regions, orders, etc)" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ] + }, + { + "id": 1643, + "name": "deleteDocument", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1644, + "name": "deleteDocument", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to delete document" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "returns response from search engine provider" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1645, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the index name" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1646, + "name": "document_id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the id of the document" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ] + }, + { + "id": 1647, + "name": "deleteAllDocuments", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1648, + "name": "deleteAllDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to delete all documents" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "returns response from search engine provider" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1649, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the index name" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ] + }, + { + "id": 1650, + "name": "search", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1651, + "name": "search", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to search for a document in an index" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "returns response from search engine provider" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1652, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the index name" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1653, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the search query" + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1654, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "any options passed to the request object other than the query and indexName\n- additionalOptions contain any provider specific options" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ] + }, + { + "id": 1655, + "name": "updateSettings", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1656, + "name": "updateSettings", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to update the settings of an index" + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "returns response from search engine provider" + } + ] + } + ] + }, + "parameters": [ + { + "id": 1657, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the index name" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1658, + "name": "settings", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "settings object" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ] + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1625 + ] + }, + { + "title": "Methods", + "children": [ + 1626, + 1630, + 1633, + 1638, + 1643, + 1647, + 1650, + 1655 + ] + } + ] + } + ], + "groups": [ + { + "title": "Interfaces", + "children": [ + 1624 + ] + }, + { + "title": "Type Aliases", + "children": [ + 1616 + ] + } + ] + }, + { + "id": 2244, + "name": "SharedContext", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A shared context object that is used to share resources between the application and the module." + } + ] + }, + "children": [ + { + "id": 2245, + "name": "transactionManager", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of a transaction manager." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + }, + { + "id": 2246, + "name": "manager", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of an entity manager." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2245, + 2246 + ] + } + ] + }, + { + "id": 2247, + "name": "Context", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A shared context object that is used to share resources between the application and the module." + } + ] + }, + "children": [ + { + "id": 2248, + "name": "transactionManager", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of a transaction manager of type " + }, + { + "kind": "code", + "text": "`TManager`" + }, + { + "kind": "text", + "text": ", which is a typed parameter passed to the context to specify the type of the " + }, + { + "kind": "code", + "text": "`transactionManager`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "reference", + "target": 2253, + "name": "TManager", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + { + "id": 2249, + "name": "manager", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of a manager, typically an entity manager, of type " + }, + { + "kind": "code", + "text": "`TManager`" + }, + { + "kind": "text", + "text": ", which is a typed parameter passed to the context to specify the type of the " + }, + { + "kind": "code", + "text": "`manager`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "reference", + "target": 2253, + "name": "TManager", + "package": "@medusajs/types", + "refersToTypeParameter": true + } + }, + { + "id": 2250, + "name": "isolationLevel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A string indicating the isolation level of the context. Possible values are " + }, + { + "kind": "code", + "text": "`READ UNCOMMITTED`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`READ COMMITTED`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`REPEATABLE READ`" + }, + { + "kind": "text", + "text": ", or " + }, + { + "kind": "code", + "text": "`SERIALIZABLE`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2251, + "name": "enableNestedTransactions", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A boolean value indicating whether nested transactions are enabled." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 2252, + "name": "transactionId", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A string indicating the ID of the current transaction." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2248, + 2249, + 2250, + 2251, + 2252 + ] + } + ], + "typeParameters": [ + { + "id": 2253, + "name": "TManager", + "variant": "typeParam", + "kind": 131072, + "flags": {}, + "default": { + "type": "intrinsic", + "name": "unknown" + } + } + ] + }, + { + "id": 1659, + "name": "TransactionBaseTypes", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 1660, + "name": "ITransactionBaseService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1661, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 1662, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 1663, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 1661 + ] + } + ], + "extendedBy": [ + { + "type": "reference", + "target": 1015, + "name": "IEventBusService" + } + ] + } + ], + "groups": [ + { + "title": "Interfaces", + "children": [ + 1660 + ] + } + ] + }, + { + "id": 1664, + "name": "WorkflowTypes", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 1665, + "name": "CartWorkflow", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 1666, + "name": "CreateLineItemInputDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1667, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1668, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } } ], "groups": [ { - "title": "Methods", + "title": "Properties", "children": [ - 1734 + 1667, + 1668 + ] + } + ] + }, + { + "id": 1669, + "name": "CreateCartWorkflowInputDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1670, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1671, + "name": "country_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1672, + "name": "items", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1666, + "name": "CreateLineItemInputDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1673, + "name": "context", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "object" + } + }, + { + "id": 1674, + "name": "sales_channel_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1675, + "name": "shipping_address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1676, + "name": "billing_address_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1677, + "name": "billing_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1, + "name": "AddressDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1678, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 1, + "name": "AddressDTO", + "package": "@medusajs/types" + } + }, + { + "id": 1679, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1680, + "name": "email", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1670, + 1671, + 1672, + 1673, + 1674, + 1675, + 1676, + 1677, + 1678, + 1679, + 1680 ] } ] } - } - ] - } - }, - { - "id": 1657, - "name": "SessionOptions", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1658, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1659, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1660, - "name": "resave", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1661, - "name": "rolling", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1662, - "name": "saveUninitialized", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1663, - "name": "secret", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1664, - "name": "ttl", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "number" - } - } ], "groups": [ { - "title": "Properties", + "title": "Interfaces", "children": [ - 1659, - 1660, - 1661, - 1662, - 1663, - 1664 + 1666, + 1669 ] } ] - } - } - }, - { - "id": 127, - "name": "UpdateAuthProviderDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 128, - "name": "__type", + }, + { + "id": 1681, + "name": "CommonWorkflow", "variant": "declaration", - "kind": 65536, + "kind": 4, "flags": {}, "children": [ { - "id": 131, - "name": "domain", + "id": 1682, + "name": "WorkflowInputConfig", "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": 133, - "name": "ProviderDomain", - "package": "@medusajs/types" - } - }, - { - "id": 132, - "name": "is_active", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 130, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 129, - "name": "provider", - "variant": "declaration", - "kind": 1024, + "kind": 256, "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", "children": [ - 131, - 132, - 130, - 129 - ] - } - ] - } - } - }, - { - "id": 104, - "name": "UpdateAuthUserDTO", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 105, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 109, - "name": "app_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" + { + "id": 1683, + "name": "listConfig", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, - { - "type": "intrinsic", - "name": "unknown" + "type": { + "type": "reflection", + "declaration": { + "id": 1684, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1685, + "name": "select", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1686, + "name": "relations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1685, + 1686 + ] + } + ] + } } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 106, - "name": "id", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 107, - "name": "provider_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" + { + "id": 1687, + "name": "retrieveConfig", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true }, - { - "type": "intrinsic", - "name": "unknown" + "type": { + "type": "reflection", + "declaration": { + "id": 1688, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1689, + "name": "select", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1690, + "name": "relations", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1689, + 1690 + ] + } + ] + } } - ], - "name": "Record", - "package": "typescript" - } - }, - { - "id": 108, - "name": "user_metadata", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "reference", - "target": { - "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", - "qualifiedName": "Record" - }, - "typeArguments": [ - { - "type": "intrinsic", - "name": "string" - }, - { - "type": "intrinsic", - "name": "unknown" - } - ], - "name": "Record", - "package": "typescript" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 109, - 106, - 107, - 108 - ] - } - ] - } - } - }, - { - "id": 1180, - "name": "UploadStreamDescriptorType", - "variant": "declaration", - "kind": 2097152, - "flags": {}, - "type": { - "type": "reflection", - "declaration": { - "id": 1181, - "name": "__type", - "variant": "declaration", - "kind": 65536, - "flags": {}, - "children": [ - { - "id": 1183, - "name": "ext", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "string" - } - }, - { - "id": 1184, - "name": "isPrivate", - "variant": "declaration", - "kind": 1024, - "flags": { - "isOptional": true - }, - "type": { - "type": "intrinsic", - "name": "boolean" - } - }, - { - "id": 1182, - "name": "name", - "variant": "declaration", - "kind": 1024, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" - } - } - ], - "groups": [ - { - "title": "Properties", - "children": [ - 1183, - 1184, - 1182 - ] - } - ], - "indexSignature": { - "id": 1185, - "name": "__index", - "variant": "signature", - "kind": 8192, - "flags": {}, - "parameters": [ - { - "id": 1186, - "name": "x", - "variant": "param", - "kind": 32768, - "flags": {}, - "type": { - "type": "intrinsic", - "name": "string" } - } - ], - "type": { - "type": "intrinsic", - "name": "unknown" + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1683, + 1687 + ] + } + ] } + ], + "groups": [ + { + "title": "Interfaces", + "children": [ + 1682 + ] + } + ] + }, + { + "id": 1691, + "name": "PriceListWorkflow", + "variant": "declaration", + "kind": 4, + "flags": {}, + "children": [ + { + "id": 1692, + "name": "CreatePriceListDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1693, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1694, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1695, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2127, + "name": "PriceListStatus", + "package": "@medusajs/types" + } + }, + { + "id": 1696, + "name": "rules_count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1697, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2196, + "name": "PriceListRuleDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1698, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 1699, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1700, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1701, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1702, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1703, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1704, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1700, + 1701, + 1702, + 1703, + 1704 + ] + } + ] + } + } + } + }, + { + "id": 1705, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 1706, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1707, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1707 + ] + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1693, + 1694, + 1695, + 1696, + 1697, + 1698, + 1705 + ] + } + ] + }, + { + "id": 1708, + "name": "CreatePriceListRuleDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1709, + "name": "rule_attribute", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1710, + "name": "value", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1709, + 1710 + ] + } + ] + }, + { + "id": 1711, + "name": "CreatePriceListPriceDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1712, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1713, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1714, + "name": "price_set_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 1715, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1716, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1717, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1712, + 1713, + 1714, + 1715, + 1716, + 1717 + ] + } + ] + }, + { + "id": 1718, + "name": "CreatePriceListWorkflowInputDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1719, + "name": "price_lists", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1729, + "name": "CreatePriceListWorkflowDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1719 + ] + } + ] + }, + { + "id": 1720, + "name": "RemovePriceListProductsWorkflowInputDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1721, + "name": "product_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1722, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1721, + 1722 + ] + } + ] + }, + { + "id": 1723, + "name": "RemovePriceListVariantsWorkflowInputDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1724, + "name": "variant_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1725, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1724, + 1725 + ] + } + ] + }, + { + "id": 1726, + "name": "RemovePriceListPricesWorkflowInputDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1727, + "name": "money_amount_ids", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + }, + { + "id": 1728, + "name": "price_list_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1727, + 1728 + ] + } + ] + }, + { + "id": 1729, + "name": "CreatePriceListWorkflowDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1730, + "name": "title", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1731, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1732, + "name": "description", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1733, + "name": "type", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1734, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1735, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1736, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2127, + "name": "PriceListStatus", + "package": "@medusajs/types" + } + }, + { + "id": 1737, + "name": "rules_count", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 1738, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 2317, + "name": "InputPrice", + "package": "@medusajs/types" + } + } + }, + { + "id": 1739, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2155, + "name": "CreatePriceListRules", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1730, + 1731, + 1732, + 1733, + 1734, + 1735, + 1736, + 1737, + 1738, + 1739 + ] + } + ] + }, + { + "id": 1757, + "name": "RemovePriceListWorkflowInputDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1758, + "name": "price_lists", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1758 + ] + } + ] + }, + { + "id": 1740, + "name": "PriceListVariantPriceDTO", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/workflow/product/update-products.ts", + "qualifiedName": "UpdateProductVariantPricesInputDTO" + }, + "name": "UpdateProductVariantPricesInputDTO", + "package": "@medusajs/types" + }, + { + "type": "reflection", + "declaration": { + "id": 1741, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1742, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1743, + "name": "price_set_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1742, + 1743 + ] + } + ] + } + } + ] + } + }, + { + "id": 1744, + "name": "UpdatePriceListWorkflowDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1745, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1746, + "name": "name", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 1747, + "name": "starts_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1748, + "name": "ends_at", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Date" + }, + "name": "Date", + "package": "typescript" + } + }, + { + "id": 1749, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2127, + "name": "PriceListStatus", + "package": "@medusajs/types" + } + }, + { + "id": 1750, + "name": "rules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": 2155, + "name": "CreatePriceListRules", + "package": "@medusajs/types" + } + }, + { + "id": 1751, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1740, + "name": "PriceListVariantPriceDTO", + "package": "@medusajs/types" + } + } + }, + { + "id": 1752, + "name": "customer_groups", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 1753, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 1754, + "name": "id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1754 + ] + } + ] + } + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1745, + 1746, + 1747, + 1748, + 1749, + 1750, + 1751, + 1752 + ] + } + ] + }, + { + "id": 1755, + "name": "UpdatePriceListWorkflowInputDTO", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 1756, + "name": "price_lists", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1744, + "name": "UpdatePriceListWorkflowDTO", + "package": "@medusajs/types" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 1756 + ] + } + ] + } + ], + "groups": [ + { + "title": "Interfaces", + "children": [ + 1692, + 1708, + 1711, + 1718, + 1720, + 1723, + 1726, + 1729, + 1757, + 1744, + 1755 + ] + }, + { + "title": "Type Aliases", + "children": [ + 1740 + ] + } + ] + } + ], + "groups": [ + { + "title": "Namespaces", + "children": [ + 1665, + 1681, + 1691 + ] + } + ] + }, + { + "id": 2317, + "name": "InputPrice", + "variant": "declaration", + "kind": 256, + "flags": {}, + "children": [ + { + "id": 2318, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2319, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2320, + "name": "amount", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2321, + "name": "variant_id", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 2322, + "name": "min_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 2323, + "name": "max_quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" } } - } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2318, + 2319, + 2320, + 2321, + 2322, + 2323 + ] + } + ] } ], "groups": [ @@ -35292,27 +48681,27 @@ 152, 153, 167, - 203, - 389, - 411, - 541, - 607, - 626, - 684, - 851, - 990, - 1002, - 1013, - 1057, - 1062 + 654, + 837, + 859, + 989, + 1055, + 1074, + 1132, + 1299, + 1592, + 1604, + 1615, + 1659, + 1664 ] }, { "title": "Enumerations", "children": [ - 1538, - 1541, - 133 + 133, + 2127, + 2130 ] }, { @@ -35324,81 +48713,88 @@ { "title": "Interfaces", "children": [ - 1636, - 1432, - 1419, - 1695, - 1398, - 1389, - 1650, - 1295, - 1320, - 1567, - 1613, - 1628, - 1566, - 1351, - 1438, - 1466, - 1483, - 1565, - 1504, - 1424, - 1522, - 1290, 137, 110, - 1305, - 1333, - 1586, - 1594, - 1601, - 1368, - 1472, - 1492, - 1445, - 1511, - 1532, 16, - 1253, - 1721, - 1214, - 1217, - 1200, - 1197, - 1309, - 1544, - 1556, - 1607, - 1624, - 1338, - 1385, - 1450, - 1478, - 1499, - 1381, - 1383, - 1375, - 1645, - 1245, - 1220, - 1238, - 1642, - 1435, - 1517, - 1639, - 1647, - 1300, - 1327, - 1577, - 1618, - 1632, - 1360, - 1443, - 1461, - 1487, - 1507, - 1527 + 2276, + 2291, + 1759, + 1762, + 1767, + 1770, + 1772, + 1786, + 1789, + 1803, + 1806, + 1809, + 1827, + 1834, + 1842, + 2234, + 1879, + 1884, + 1889, + 1894, + 1898, + 1909, + 1916, + 1922, + 2133, + 2145, + 2154, + 2155, + 2156, + 2166, + 2175, + 2183, + 2190, + 2196, + 2202, + 2207, + 2213, + 2217, + 2221, + 2225, + 2228, + 2231, + 1927, + 1940, + 1949, + 1957, + 2067, + 2072, + 2076, + 2081, + 2039, + 2050, + 2055, + 2061, + 2088, + 2093, + 2096, + 2100, + 1964, + 1970, + 1972, + 1974, + 1978, + 1987, + 2008, + 2013, + 2021, + 2024, + 2027, + 2032, + 2034, + 2106, + 2111, + 2116, + 2121, + 2242, + 2244, + 2247, + 2317 ] }, { @@ -35406,30 +48802,24 @@ "children": [ 1, 115, - 90, 121, - 98, - 1175, - 1690, - 1730, - 1161, - 1157, - 1736, - 1738, - 1169, - 1187, - 1720, - 1665, - 1688, - 1687, - 1740, - 1728, - 1750, - 1732, - 1657, 127, + 90, + 98, 104, - 1180 + 2286, + 2324, + 2326, + 2328, + 2346, + 2336, + 2254, + 2334, + 2332, + 2283, + 2284, + 1776, + 2316 ] } ], @@ -36101,6293 +49491,8653 @@ }, "168": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "CartDTO" + "qualifiedName": "AdjustmentLineDTO" }, "169": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type" + "qualifiedName": "AdjustmentLineDTO.id" }, "170": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.id" + "qualifiedName": "AdjustmentLineDTO.code" }, "171": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.email" + "qualifiedName": "AdjustmentLineDTO.amount" }, "172": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.billing_address_id" + "qualifiedName": "AdjustmentLineDTO.description" }, "173": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.shipping_address_id" + "qualifiedName": "AdjustmentLineDTO.promotion_id" }, "174": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.region_id" + "qualifiedName": "AdjustmentLineDTO.provider_id" }, "175": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.customer_id" + "qualifiedName": "AdjustmentLineDTO.created_at" }, "176": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.payment_id" + "qualifiedName": "AdjustmentLineDTO.updated_at" }, "177": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.completed_at" + "qualifiedName": "ShippingMethodAdjustmentLineDTO" }, "178": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.payment_authorized_at" + "qualifiedName": "ShippingMethodAdjustmentLineDTO.shipping_method" }, "179": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.idempotency_key" + "qualifiedName": "AdjustmentLineDTO.id" }, "180": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.context" + "qualifiedName": "AdjustmentLineDTO.code" }, "181": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.metadata" + "qualifiedName": "AdjustmentLineDTO.amount" }, "182": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.sales_channel_id" + "qualifiedName": "AdjustmentLineDTO.description" }, "183": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.shipping_total" + "qualifiedName": "AdjustmentLineDTO.promotion_id" }, "184": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.discount_total" + "qualifiedName": "AdjustmentLineDTO.provider_id" }, "185": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.raw_discount_total" + "qualifiedName": "AdjustmentLineDTO.created_at" }, "186": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.item_tax_total" + "qualifiedName": "AdjustmentLineDTO.updated_at" }, "187": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.shipping_tax_total" + "qualifiedName": "LineItemAdjustmentLineDTO" }, "188": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.tax_total" + "qualifiedName": "LineItemAdjustmentLineDTO.line_item" }, "189": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.refunded_total" + "qualifiedName": "AdjustmentLineDTO.id" }, "190": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.total" + "qualifiedName": "AdjustmentLineDTO.code" }, "191": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.subtotal" + "qualifiedName": "AdjustmentLineDTO.amount" }, "192": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.refundable_amount" + "qualifiedName": "AdjustmentLineDTO.description" }, "193": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.gift_card_total" + "qualifiedName": "AdjustmentLineDTO.promotion_id" }, "194": { "sourceFileName": "../../../packages/types/src/cart/common.ts", - "qualifiedName": "__type.gift_card_tax_total" + "qualifiedName": "AdjustmentLineDTO.provider_id" }, "195": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "AdjustmentLineDTO.created_at" + }, + "196": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "AdjustmentLineDTO.updated_at" + }, + "197": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO" + }, + "198": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.id" + }, + "199": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.description" + }, + "200": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.tax_rate_id" + }, + "201": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.code" + }, + "202": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.rate" + }, + "203": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.provider_id" + }, + "204": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.created_at" + }, + "205": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.updated_at" + }, + "206": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "ShippingMethodTaxLineDTO" + }, + "207": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "ShippingMethodTaxLineDTO.shipping_method" + }, + "208": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.id" + }, + "209": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.description" + }, + "210": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.tax_rate_id" + }, + "211": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.code" + }, + "212": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.rate" + }, + "213": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.provider_id" + }, + "214": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.created_at" + }, + "215": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.updated_at" + }, + "216": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "LineItemTaxLineDTO" + }, + "217": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "LineItemTaxLineDTO.line_item" + }, + "218": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.id" + }, + "219": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.description" + }, + "220": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.tax_rate_id" + }, + "221": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.code" + }, + "222": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.rate" + }, + "223": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.provider_id" + }, + "224": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.created_at" + }, + "225": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "TaxLineDTO.updated_at" + }, + "226": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO" + }, + "227": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.id" + }, + "228": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.customer_id" + }, + "229": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.first_name" + }, + "230": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.last_name" + }, + "231": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.phone" + }, + "232": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.company" + }, + "233": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.address_1" + }, + "234": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.address_2" + }, + "235": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.city" + }, + "236": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.country_code" + }, + "237": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.province" + }, + "238": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.postal_code" + }, + "239": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.metadata" + }, + "240": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.created_at" + }, + "241": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartAddressDTO.updated_at" + }, + "242": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO" + }, + "243": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.id" + }, + "244": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.name" + }, + "245": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.description" + }, + "246": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.unit_price" + }, + "247": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.is_tax_inclusive" + }, + "248": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.shipping_option_id" + }, + "249": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.data" + }, + "250": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.metadata" + }, + "251": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.tax_lines" + }, + "252": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.adjustments" + }, + "253": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.created_at" + }, + "254": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.updated_at" + }, + "255": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.original_total" + }, + "256": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.original_subtotal" + }, + "257": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.original_tax_total" + }, + "258": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.total" + }, + "259": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.subtotal" + }, + "260": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.tax_total" + }, + "261": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.discount_total" + }, + "262": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartShippingMethodDTO.discount_tax_total" + }, + "263": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO" + }, + "264": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.id" + }, + "265": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.title" + }, + "266": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.subtitle" + }, + "267": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.thumbnail" + }, + "268": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.quantity" + }, + "269": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.product_id" + }, + "270": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.product_title" + }, + "271": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.product_description" + }, + "272": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.product_subtitle" + }, + "273": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.product_type" + }, + "274": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.product_collection" + }, + "275": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.product_handle" + }, + "276": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.variant_id" + }, + "277": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.variant_sku" + }, + "278": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.variant_barcode" + }, + "279": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.variant_title" + }, + "280": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.variant_option_values" + }, + "281": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.requires_shipping" + }, + "282": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.is_discountable" + }, + "283": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.is_tax_inclusive" + }, + "284": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.compare_at_unit_price" + }, + "285": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.unit_price" + }, + "286": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.tax_lines" + }, + "287": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.adjustments" + }, + "288": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.cart" + }, + "289": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.cart_id" + }, + "290": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.metadata" + }, + "291": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.created_at" + }, + "292": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.updated_at" + }, + "293": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.original_total" + }, + "294": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.original_subtotal" + }, + "295": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.original_tax_total" + }, + "296": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.item_total" + }, + "297": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.item_subtotal" + }, + "298": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.item_tax_total" + }, + "299": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.total" + }, + "300": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.subtotal" + }, + "301": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.tax_total" + }, + "302": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.discount_total" + }, + "303": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartLineItemDTO.discount_tax_total" + }, + "304": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO" + }, + "305": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.id" + }, + "306": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.region_id" + }, + "307": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.customer_id" + }, + "308": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.sales_channel_id" + }, + "309": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.email" + }, + "310": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.currency_code" + }, + "311": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.shipping_address" + }, + "312": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.billing_address" + }, + "313": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.items" + }, + "314": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.shipping_methods" + }, + "315": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.metadata" + }, + "316": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.created_at" + }, + "317": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.updated_at" + }, + "318": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.original_item_total" + }, + "319": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.original_item_subtotal" + }, + "320": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.original_item_tax_total" + }, + "321": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.item_total" + }, + "322": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.item_subtotal" + }, + "323": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.item_tax_total" + }, + "324": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.original_total" + }, + "325": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.original_subtotal" + }, + "326": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.original_tax_total" + }, + "327": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.total" + }, + "328": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.subtotal" + }, + "329": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.tax_total" + }, + "330": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.discount_total" + }, + "331": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.discount_tax_total" + }, + "332": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.shipping_total" + }, + "333": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.shipping_subtotal" + }, + "334": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.shipping_tax_total" + }, + "335": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.original_shipping_total" + }, + "336": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.original_shipping_subtotal" + }, + "337": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "CartDTO.original_shipping_tax_total" + }, + "338": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableCartProps" + }, + "339": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableCartProps.id" + }, + "340": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableCartProps.sales_channel_id" + }, + "341": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableCartProps.customer_id" + }, + "342": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableCartProps.region_id" + }, + "343": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableCartProps.created_at" + }, + "344": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableCartProps.updated_at" + }, + "345": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "346": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "347": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableAddressProps" + }, + "348": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableAddressProps.id" + }, + "349": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "350": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "351": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableLineItemProps" + }, + "352": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableLineItemProps.id" + }, + "353": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableLineItemProps.cart_id" + }, + "354": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableLineItemProps.title" + }, + "355": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableLineItemProps.variant_id" + }, + "356": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "FilterableLineItemProps.product_id" + }, + "357": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "358": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "359": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "legacy_CartDTO" + }, + "360": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type" + }, + "361": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.id" + }, + "362": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.email" + }, + "363": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.billing_address_id" + }, + "364": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.shipping_address_id" + }, + "365": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.region_id" + }, + "366": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.customer_id" + }, + "367": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.payment_id" + }, + "368": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.completed_at" + }, + "369": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.payment_authorized_at" + }, + "370": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.idempotency_key" + }, + "371": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.context" + }, + "372": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.metadata" + }, + "373": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.sales_channel_id" + }, + "374": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.shipping_total" + }, + "375": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.discount_total" + }, + "376": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.raw_discount_total" + }, + "377": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.item_tax_total" + }, + "378": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.shipping_tax_total" + }, + "379": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.tax_total" + }, + "380": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.refunded_total" + }, + "381": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.total" + }, + "382": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.subtotal" + }, + "383": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.refundable_amount" + }, + "384": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.gift_card_total" + }, + "385": { + "sourceFileName": "../../../packages/types/src/cart/common.ts", + "qualifiedName": "__type.gift_card_tax_total" + }, + "386": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO" + }, + "387": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.customer_id" + }, + "388": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.company" + }, + "389": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.first_name" + }, + "390": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.last_name" + }, + "391": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.address_1" + }, + "392": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.address_2" + }, + "393": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.city" + }, + "394": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.country_code" + }, + "395": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.province" + }, + "396": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.postal_code" + }, + "397": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.phone" + }, + "398": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.metadata" + }, + "399": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateAddressDTO" + }, + "400": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateAddressDTO.id" + }, + "401": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.customer_id" + }, + "402": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.company" + }, + "403": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.first_name" + }, + "404": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.last_name" + }, + "405": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.address_1" + }, + "406": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.address_2" + }, + "407": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.city" + }, + "408": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.country_code" + }, + "409": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.province" + }, + "410": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.postal_code" + }, + "411": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.phone" + }, + "412": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.metadata" + }, + "413": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateAddressDTO" + }, + "414": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.customer_id" + }, + "415": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.company" + }, + "416": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.first_name" + }, + "417": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.last_name" + }, + "418": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.address_1" + }, + "419": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.address_2" + }, + "420": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.city" + }, + "421": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.country_code" + }, + "422": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.province" + }, + "423": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.postal_code" + }, + "424": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.phone" + }, + "425": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpsertAddressDTO.metadata" + }, + "426": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateCartDTO" + }, + "427": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateCartDTO.region_id" + }, + "428": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateCartDTO.customer_id" + }, + "429": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateCartDTO.sales_channel_id" + }, + "430": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateCartDTO.email" + }, + "431": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateCartDTO.currency_code" + }, + "432": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateCartDTO.shipping_address_id" + }, + "433": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateCartDTO.billing_address_id" + }, + "434": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateCartDTO.shipping_address" + }, + "435": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateCartDTO.billing_address" + }, + "436": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateCartDTO.metadata" + }, + "437": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateCartDTO" + }, + "438": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateCartDTO.id" + }, + "439": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateCartDTO.region_id" + }, + "440": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateCartDTO.customer_id" + }, + "441": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateCartDTO.sales_channel_id" + }, + "442": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateCartDTO.email" + }, + "443": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateCartDTO.currency_code" + }, + "444": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateCartDTO.shipping_address_id" + }, + "445": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateCartDTO.billing_address_id" + }, + "446": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateCartDTO.billing_address" + }, + "447": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateCartDTO.shipping_address" + }, + "448": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateCartDTO.metadata" + }, + "449": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemTaxLineDTO" + }, + "450": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemTaxLineDTO.description" + }, + "451": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemTaxLineDTO.tax_rate_id" + }, + "452": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemTaxLineDTO.code" + }, + "453": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemTaxLineDTO.rate" + }, + "454": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemTaxLineDTO.provider_id" + }, + "455": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemAdjustmentDTO" + }, + "456": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemAdjustmentDTO.code" + }, + "457": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemAdjustmentDTO.amount" + }, + "458": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemAdjustmentDTO.description" + }, + "459": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemAdjustmentDTO.promotion_id" + }, + "460": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemAdjustmentDTO.provider_id" + }, + "461": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemTaxLineDTO" + }, + "462": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemTaxLineDTO.id" + }, + "463": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemTaxLineDTO.description" + }, + "464": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemTaxLineDTO.tax_rate_id" + }, + "465": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemTaxLineDTO.code" + }, + "466": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemTaxLineDTO.rate" + }, + "467": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemTaxLineDTO.provider_id" + }, + "468": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemAdjustmentDTO" + }, + "469": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemAdjustmentDTO.id" + }, + "470": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemAdjustmentDTO.code" + }, + "471": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemAdjustmentDTO.amount" + }, + "472": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemAdjustmentDTO.description" + }, + "473": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemAdjustmentDTO.promotion_id" + }, + "474": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemAdjustmentDTO.provider_id" + }, + "475": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO" + }, + "476": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.title" + }, + "477": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.subtitle" + }, + "478": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.thumbnail" + }, + "479": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.cart_id" + }, + "480": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.quantity" + }, + "481": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_id" + }, + "482": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_title" + }, + "483": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_description" + }, + "484": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_subtitle" + }, + "485": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_type" + }, + "486": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_collection" + }, + "487": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_handle" + }, + "488": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.variant_id" + }, + "489": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.variant_sku" + }, + "490": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.variant_barcode" + }, + "491": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.variant_title" + }, + "492": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.variant_option_values" + }, + "493": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.requires_shipping" + }, + "494": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.is_discountable" + }, + "495": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.is_tax_inclusive" + }, + "496": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.compare_at_unit_price" + }, + "497": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.unit_price" + }, + "498": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.tax_lines" + }, + "499": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.adjustments" + }, + "500": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemForCartDTO" + }, + "501": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemForCartDTO.cart_id" + }, + "502": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.title" + }, + "503": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.subtitle" + }, + "504": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.thumbnail" + }, + "505": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.quantity" + }, + "506": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_id" + }, + "507": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_title" + }, + "508": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_description" + }, + "509": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_subtitle" + }, + "510": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_type" + }, + "511": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_collection" + }, + "512": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.product_handle" + }, + "513": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.variant_id" + }, + "514": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.variant_sku" + }, + "515": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.variant_barcode" + }, + "516": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.variant_title" + }, + "517": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.variant_option_values" + }, + "518": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.requires_shipping" + }, + "519": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.is_discountable" + }, + "520": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.is_tax_inclusive" + }, + "521": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.compare_at_unit_price" + }, + "522": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.unit_price" + }, + "523": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.tax_lines" + }, + "524": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "CreateLineItemDTO.adjustments" + }, + "525": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemWithSelectorDTO" + }, + "526": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemWithSelectorDTO.selector" + }, + "527": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemWithSelectorDTO.data" + }, + "528": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemDTO" + }, + "529": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemDTO.id" + }, + "530": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemDTO.title" + }, + "531": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemDTO.quantity" + }, + "532": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemDTO.unit_price" + }, + "533": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemDTO.tax_lines" + }, + "534": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "UpdateLineItemDTO.adjustments" + }, + "535": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "cart_id" + }, + "536": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "variant_id" + }, + "537": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "product_id" + }, + "538": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "subtitle" + }, + "539": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "thumbnail" + }, + "540": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "product_title" + }, + "541": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "product_description" + }, + "542": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "product_subtitle" + }, + "543": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "product_type" + }, + "544": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "product_collection" + }, + "545": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "product_handle" + }, + "546": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "variant_sku" + }, + "547": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "variant_barcode" + }, + "548": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "variant_title" + }, + "549": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "variant_option_values" + }, + "550": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "requires_shipping" + }, + "551": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "is_discountable" + }, + "552": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "is_tax_inclusive" + }, + "553": { + "sourceFileName": "../../../packages/types/src/cart/mutations.ts", + "qualifiedName": "compare_at_unit_price" + }, + "554": { "sourceFileName": "../../../packages/types/src/cart/service.ts", "qualifiedName": "ICartModuleService" }, - "196": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "IModuleService.__joinerConfig" - }, - "197": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "IModuleService.__joinerConfig" - }, - "198": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "IModuleService.__hooks" - }, - "199": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" - }, - "200": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.onApplicationStart" - }, - "201": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" - }, - "202": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" - }, - "203": { - "sourceFileName": "../../../packages/types/src/common/index.ts", - "qualifiedName": "" - }, - "204": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "WithRequiredProperty" - }, - "205": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "T" - }, - "206": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "K" - }, - "207": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "PartialPick" - }, - "208": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "T" - }, - "209": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "K" - }, - "210": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "BaseEntity" - }, - "211": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "BaseEntity.id" - }, - "212": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "BaseEntity.created_at" - }, - "213": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "BaseEntity.updated_at" - }, - "214": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "SoftDeletableEntity" - }, - "215": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "SoftDeletableEntity.deleted_at" - }, - "216": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "BaseEntity.id" - }, - "217": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "BaseEntity.created_at" - }, - "218": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "BaseEntity.updated_at" - }, - "219": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "Writable" - }, - "220": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "T" - }, - "221": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindConfig" - }, - "222": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindConfig.select" - }, - "223": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindConfig.skip" - }, - "224": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindConfig.take" - }, - "225": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindConfig.relations" - }, - "226": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindConfig.order" - }, - "227": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type" - }, - "228": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.__index" - }, - "230": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindConfig.withDeleted" - }, - "231": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindConfig.Entity" - }, - "232": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "ExtendedFindConfig" - }, - "233": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type" - }, - "234": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.select" - }, - "235": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.relations" - }, - "236": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.where" - }, - "237": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.order" - }, - "238": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.skip" - }, - "239": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.take" - }, - "240": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "TEntity" - }, - "241": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "QuerySelector" - }, - "242": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type" - }, - "243": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.q" - }, - "244": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "TEntity" - }, - "245": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "TreeQuerySelector" - }, - "246": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type" - }, - "247": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.include_descendants_tree" - }, - "248": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "TEntity" - }, - "249": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "Selector" - }, - "250": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "TEntity" - }, - "251": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "TotalField" - }, - "252": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "CustomFindOptions" - }, - "253": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "CustomFindOptions.select" - }, - "254": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "CustomFindOptions.where" - }, - "255": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "CustomFindOptions.order" - }, - "256": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "CustomFindOptions.skip" - }, - "257": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "CustomFindOptions.take" - }, - "258": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "CustomFindOptions.TModel" - }, - "259": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "CustomFindOptions.InKeys" - }, - "260": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "QueryConfig" - }, - "261": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type" - }, - "262": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.defaultFields" - }, - "263": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.defaultRelations" - }, - "264": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.allowedFields" - }, - "265": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.allowedRelations" - }, - "266": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.defaultLimit" - }, - "267": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.isList" - }, - "268": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "TEntity" - }, - "269": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "RequestQueryFields" - }, - "270": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type" - }, - "271": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.expand" - }, - "272": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.fields" - }, - "273": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.offset" - }, - "274": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.limit" - }, - "275": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.order" - }, - "276": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "PaginatedResponse" - }, - "277": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type" - }, - "278": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.limit" - }, - "279": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.offset" - }, - "280": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.count" - }, - "281": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "DeleteResponse" - }, - "282": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type" - }, - "283": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.id" - }, - "284": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.object" - }, - "285": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "__type.deleted" - }, - "286": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "EmptyQueryParams" - }, - "287": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "RepositoryTransformOptions" - }, - "288": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "DateComparisonOperator" - }, - "289": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "DateComparisonOperator.lt" - }, - "290": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "DateComparisonOperator.gt" - }, - "291": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "DateComparisonOperator.gte" - }, - "292": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "DateComparisonOperator.lte" - }, - "293": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "StringComparisonOperator" - }, - "294": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "StringComparisonOperator.lt" - }, - "295": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "StringComparisonOperator.gt" - }, - "296": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "StringComparisonOperator.gte" - }, - "297": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "StringComparisonOperator.lte" - }, - "298": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "StringComparisonOperator.contains" - }, - "299": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "StringComparisonOperator.starts_with" - }, - "300": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "StringComparisonOperator.ends_with" - }, - "301": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "NumericalComparisonOperator" - }, - "302": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "NumericalComparisonOperator.lt" - }, - "303": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "NumericalComparisonOperator.gt" - }, - "304": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "NumericalComparisonOperator.gte" - }, - "305": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "NumericalComparisonOperator.lte" - }, - "306": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressPayload" - }, - "307": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressPayload.first_name" - }, - "308": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressPayload.last_name" - }, - "309": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressPayload.phone" - }, - "310": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressPayload.metadata" - }, - "311": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressPayload.company" - }, - "312": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressPayload.address_1" - }, - "313": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressPayload.address_2" - }, - "314": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressPayload.city" - }, - "315": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressPayload.country_code" - }, - "316": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressPayload.province" - }, - "317": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressPayload.postal_code" - }, - "318": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressCreatePayload" - }, - "319": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressCreatePayload.first_name" - }, - "320": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressCreatePayload.last_name" - }, - "321": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressCreatePayload.phone" - }, - "322": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressCreatePayload.metadata" - }, - "323": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressCreatePayload.company" - }, - "324": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressCreatePayload.address_1" - }, - "325": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressCreatePayload.address_2" - }, - "326": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressCreatePayload.city" - }, - "327": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressCreatePayload.country_code" - }, - "328": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressCreatePayload.province" - }, - "329": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "AddressCreatePayload.postal_code" - }, - "330": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindParams" - }, - "331": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindParams.expand" - }, - "332": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindParams.fields" - }, - "333": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindPaginationParams" - }, - "334": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindPaginationParams.offset" - }, - "335": { - "sourceFileName": "../../../packages/types/src/common/common.ts", - "qualifiedName": "FindPaginationParams.limit" - }, - "336": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "HttpCompressionOptions" - }, - "337": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type" - }, - "338": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.enabled" - }, - "339": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.level" - }, - "340": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.memLevel" - }, - "341": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.threshold" - }, - "342": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "ProjectConfigOptions" - }, - "343": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type" - }, - "344": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.redis_url" - }, - "345": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.redis_prefix" - }, - "346": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.redis_options" - }, - "347": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.session_options" - }, - "348": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.jwt_secret" - }, - "349": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.cookie_secret" - }, - "350": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.database_url" - }, - "351": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.database_database" - }, - "352": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.database_schema" - }, - "353": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.database_logging" - }, - "354": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.database_type" - }, - "355": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.http_compression" - }, - "356": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.database_extra" - }, - "357": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type" - }, - "358": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.ssl" - }, - "359": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type" - }, - "360": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.rejectUnauthorized" - }, - "361": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.store_cors" - }, - "362": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.admin_cors" - }, - "363": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "ConfigModule" - }, - "364": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type" - }, - "365": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.projectConfig" - }, - "366": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.featureFlags" - }, - "367": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.modules" - }, - "368": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.plugins" - }, - "369": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type" - }, - "370": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.resolve" - }, - "371": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.options" - }, - "372": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "MedusaContainer" - }, - "373": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type" - }, - "374": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type.registerAdd" - }, - "375": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type" - }, - "376": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type" - }, - "377": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "name" - }, - "378": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "registration" - }, - "379": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "T" - }, - "380": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type.createScope" - }, - "381": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type" - }, - "382": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type" - }, - "383": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "ContainerLike" - }, - "384": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type" - }, - "385": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type.resolve" - }, - "386": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "__type.resolve" - }, - "387": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "T" - }, - "388": { - "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", - "qualifiedName": "key" - }, - "389": { - "sourceFileName": "../../../packages/types/src/customer/index.ts", - "qualifiedName": "" - }, - "390": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO" - }, - "391": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.id" - }, - "392": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.email" - }, - "393": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.billing_address_id" - }, - "394": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.shipping_address_id" - }, - "395": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.first_name" - }, - "396": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.last_name" - }, - "397": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.billing_address" - }, - "398": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.shipping_address" - }, - "399": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.phone" - }, - "400": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.has_account" - }, - "401": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.groups" - }, - "402": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "__type" - }, - "403": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "__type.id" - }, - "404": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.orders" - }, - "405": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "__type" - }, - "406": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "__type.id" - }, - "407": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.metadata" - }, - "408": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.deleted_at" - }, - "409": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.created_at" - }, - "410": { - "sourceFileName": "../../../packages/types/src/customer/common.ts", - "qualifiedName": "CustomerDTO.updated_at" - }, - "411": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "" - }, - "412": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "FilterQuery" - }, - "413": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type" - }, - "414": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.__index" - }, - "416": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "T" - }, - "417": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "Prev" - }, - "418": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable" - }, - "419": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "420": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "421": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.T" - }, - "422": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "OptionsQuery" - }, - "423": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "OptionsQuery.populate" - }, - "424": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "OptionsQuery.orderBy" - }, - "425": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "OptionsQuery.limit" - }, - "426": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "OptionsQuery.offset" - }, - "427": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "OptionsQuery.fields" - }, - "428": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "OptionsQuery.groupBy" - }, - "429": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "OptionsQuery.filters" - }, - "430": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "OptionsQuery.T" - }, - "431": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "OptionsQuery.P" - }, - "432": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "FindOptions" - }, - "433": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "__type" - }, - "434": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "__type.where" - }, - "435": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "__type.options" - }, - "436": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "T" - }, - "437": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService" - }, - "438": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.find" - }, - "439": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.find" - }, - "440": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "options" - }, - "441": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "442": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.findAndCount" - }, - "443": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.findAndCount" - }, - "444": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "options" - }, - "445": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "446": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.create" - }, - "447": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.create" - }, - "448": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "data" - }, - "449": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "450": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.update" - }, - "451": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.update" - }, - "452": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "data" - }, - "453": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "454": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.delete" - }, - "455": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.delete" - }, - "456": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "ids" - }, - "457": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "458": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.softDelete" - }, - "459": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.softDelete" - }, - "460": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "ids" - }, - "461": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "462": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.restore" - }, - "463": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.restore" - }, - "464": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "ids" - }, - "465": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "466": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.transaction" - }, - "467": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.transaction" - }, - "468": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TManager" - }, - "469": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "task" - }, - "470": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type" - }, - "471": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type" - }, - "472": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "transactionManager" - }, - "473": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "474": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type" - }, - "475": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type.isolationLevel" - }, - "476": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type.transaction" - }, - "477": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type.enableNestedTransactions" - }, - "478": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.getFreshManager" - }, - "479": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.getFreshManager" - }, - "480": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TManager" - }, - "481": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.getActiveManager" - }, - "482": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.getActiveManager" - }, - "483": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TManager" - }, - "484": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.serialize" - }, - "485": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.serialize" - }, - "486": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TOutput" - }, - "487": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "data" - }, - "488": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "options" - }, - "489": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RepositoryService.T" - }, - "490": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TreeRepositoryService" - }, - "491": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TreeRepositoryService.find" - }, - "492": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TreeRepositoryService.find" - }, - "493": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "options" - }, - "494": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "transformOptions" - }, - "495": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "496": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TreeRepositoryService.findAndCount" - }, - "497": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TreeRepositoryService.findAndCount" - }, - "498": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "options" - }, - "499": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "transformOptions" - }, - "500": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "501": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TreeRepositoryService.create" - }, - "502": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TreeRepositoryService.create" - }, - "503": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "data" - }, - "504": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "505": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TreeRepositoryService.delete" - }, - "506": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TreeRepositoryService.delete" - }, - "507": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "id" - }, - "508": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "509": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.transaction" - }, - "510": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.transaction" - }, - "511": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TManager" - }, - "512": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "task" - }, - "513": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type" - }, - "514": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type" - }, - "515": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "transactionManager" - }, - "516": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "context" - }, - "517": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type" - }, - "518": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type.isolationLevel" - }, - "519": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type.transaction" - }, - "520": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type.enableNestedTransactions" - }, - "521": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.getFreshManager" - }, - "522": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.getFreshManager" - }, - "523": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TManager" - }, - "524": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.getActiveManager" - }, - "525": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.getActiveManager" - }, - "526": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TManager" - }, - "527": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.serialize" - }, - "528": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.serialize" - }, - "529": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TOutput" - }, - "530": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "data" - }, - "531": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "options" - }, - "532": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TreeRepositoryService.T" - }, - "533": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "SoftDeleteReturn" - }, - "534": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type.returnLinkableKeys" - }, - "535": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TReturnableLinkableKeys" - }, - "536": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "RestoreReturn" - }, - "537": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "__type.returnLinkableKeys" - }, - "538": { - "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "TReturnableLinkableKeys" - }, - "539": { - "sourceFileName": "../../../packages/types/src/dal/entity.ts", - "qualifiedName": "EntityDateColumns" - }, - "540": { - "sourceFileName": "../../../packages/types/src/dal/entity.ts", - "qualifiedName": "SoftDeletableEntityDateColumns" - }, - "541": { - "sourceFileName": "../../../packages/types/src/event-bus/index.ts", - "qualifiedName": "" - }, - "542": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "Subscriber" - }, - "543": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type" - }, - "544": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type" - }, - "545": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "data" - }, - "546": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "eventName" - }, - "547": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "T" - }, - "548": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "SubscriberContext" - }, - "549": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type" - }, - "550": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type.subscriberId" - }, - "551": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "SubscriberDescriptor" - }, - "552": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type" - }, - "553": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type.id" - }, - "554": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type.subscriber" - }, "555": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "EventHandler" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.retrieve" }, "556": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.retrieve" }, "557": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "cartId" }, "558": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "data" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "config" }, "559": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "eventName" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "560": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "T" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.list" }, "561": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "EmitData" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.list" }, "562": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "filters" }, "563": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type.eventName" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "config" }, "564": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type.data" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "565": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "__type.options" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.listAndCount" }, "566": { - "sourceFileName": "../../../packages/types/src/event-bus/common.ts", - "qualifiedName": "T" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.listAndCount" }, "567": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "IEventBusService" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "filters" }, "568": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "IEventBusService.subscribe" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "config" }, "569": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "IEventBusService.subscribe" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "570": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "eventName" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.create" }, "571": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "subscriber" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.create" }, "572": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "context" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "data" }, "573": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "IEventBusService.unsubscribe" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "574": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "IEventBusService.unsubscribe" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.create" }, "575": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "eventName" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "data" }, "576": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "subscriber" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "577": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "context" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.update" }, "578": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "IEventBusService.emit" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.update" }, "579": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "IEventBusService.emit" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "data" }, "580": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "T" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "581": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "event" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.update" }, "582": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "sourceFileName": "../../../packages/types/src/cart/service.ts", "qualifiedName": "data" }, "583": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", - "qualifiedName": "options" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "584": { - "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", - "qualifiedName": "ITransactionBaseService.withTransaction" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.delete" }, "585": { - "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", - "qualifiedName": "ITransactionBaseService.withTransaction" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.delete" }, "586": { - "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", - "qualifiedName": "transactionManager" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "cartIds" }, "587": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "IEventBusModuleService" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "588": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "IEventBusModuleService.emit" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.delete" }, "589": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "IEventBusModuleService.emit" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "cartId" }, "590": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "T" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "591": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "eventName" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.listAddresses" }, "592": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "data" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.listAddresses" }, "593": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "options" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "filters" }, "594": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "IEventBusModuleService.emit" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "config" }, "595": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "T" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "596": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "data" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.createAddresses" }, "597": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "IEventBusModuleService.subscribe" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.createAddresses" }, "598": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "IEventBusModuleService.subscribe" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "data" }, "599": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "eventName" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "600": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "subscriber" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.createAddresses" }, "601": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "context" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "data" }, "602": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "IEventBusModuleService.unsubscribe" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "603": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "IEventBusModuleService.unsubscribe" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.updateAddresses" }, "604": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "eventName" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.updateAddresses" }, "605": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "subscriber" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "data" }, "606": { - "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", - "qualifiedName": "context" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "607": { - "sourceFileName": "../../../packages/types/src/feature-flag/index.ts", - "qualifiedName": "" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.updateAddresses" }, "608": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "IFlagRouter" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "data" }, "609": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "IFlagRouter.isFeatureEnabled" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "610": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.deleteAddresses" }, "611": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.deleteAddresses" }, "612": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "key" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ids" }, "613": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "IFlagRouter.listFlags" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "614": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.deleteAddresses" }, "615": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ids" }, "616": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "FeatureFlagsResponse" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "617": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.addLineItems" }, "618": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "__type.key" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.addLineItems" }, "619": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "__type.value" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "data" }, "620": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "FlagSettings" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.addLineItems" }, "621": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "data" }, "622": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "__type.key" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.addLineItems" }, "623": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "__type.description" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "cartId" }, "624": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "__type.env_key" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "items" }, "625": { - "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", - "qualifiedName": "__type.default_val" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "626": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.updateLineItems" }, "627": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.updateLineItems" }, "628": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.panic" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "data" }, "629": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.updateLineItems" }, "630": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "selector" }, "631": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", + "sourceFileName": "../../../packages/types/src/cart/service.ts", "qualifiedName": "data" }, "632": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.shouldLog" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "633": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.updateLineItems" }, "634": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "lineId" }, "635": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "level" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "data" }, "636": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.setLogLevel" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "637": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.removeLineItems" }, "638": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.removeLineItems" }, "639": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "level" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "itemIds" }, "640": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.unsetLogLevel" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "641": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.removeLineItems" }, "642": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "itemIds" }, "643": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.activity" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "644": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "ICartModuleService.removeLineItems" }, "645": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "selector" }, "646": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "message" + "sourceFileName": "../../../packages/types/src/cart/service.ts", + "qualifiedName": "sharedContext" }, "647": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "config" + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService.__joinerConfig" }, "648": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.progress" + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService.__joinerConfig" }, "649": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService.__hooks" }, "650": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", "qualifiedName": "__type" }, "651": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "activityId" + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.onApplicationStart" }, "652": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "message" + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" }, "653": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.error" + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" }, "654": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/index.ts", + "qualifiedName": "" }, "655": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "WithRequiredProperty" }, "656": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "messageOrError" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "T" }, "657": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "error" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "K" }, "658": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.failure" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "PartialPick" }, "659": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "T" }, "660": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "K" }, "661": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "activityId" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "BaseEntity" }, "662": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "message" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "BaseEntity.id" }, "663": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.success" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "BaseEntity.created_at" }, "664": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "BaseEntity.updated_at" }, "665": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "SoftDeletableEntity" }, "666": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "activityId" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "SoftDeletableEntity.deleted_at" }, "667": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "message" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "BaseEntity.id" }, "668": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.debug" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "BaseEntity.created_at" }, "669": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "BaseEntity.updated_at" }, "670": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "Writable" }, "671": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "message" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "T" }, "672": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.info" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindConfig" }, "673": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindConfig.select" }, "674": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindConfig.skip" }, "675": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "message" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindConfig.take" }, "676": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.warn" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindConfig.relations" }, "677": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindConfig.order" }, "678": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", + "sourceFileName": "../../../packages/types/src/common/common.ts", "qualifiedName": "__type" }, "679": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "message" - }, - "680": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "Logger.log" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.__index" }, "681": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindConfig.withDeleted" }, "682": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindConfig.Entity" }, "683": { - "sourceFileName": "../../../packages/types/src/logger/index.ts", - "qualifiedName": "args" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "ExtendedFindConfig" }, "684": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type" }, "685": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "Constructor" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.select" }, "686": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.relations" }, "687": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.where" }, "688": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "args" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.order" }, "689": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "T" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.skip" }, "690": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "LogLevel" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.take" }, "691": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "LoggerOptions" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "TEntity" }, "692": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "MODULE_SCOPE" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "QuerySelector" }, "693": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "MODULE_SCOPE.INTERNAL" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type" }, "694": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "MODULE_SCOPE.EXTERNAL" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.q" }, "695": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "MODULE_RESOURCE_TYPE" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "TEntity" }, "696": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "MODULE_RESOURCE_TYPE.SHARED" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "TreeQuerySelector" }, "697": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "MODULE_RESOURCE_TYPE.ISOLATED" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type" }, "698": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "InternalModuleDeclaration" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.include_descendants_tree" }, "699": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "TEntity" }, "700": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.scope" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "Selector" }, "701": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.resources" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "TEntity" }, "702": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.dependencies" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "TotalField" }, "703": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.definition" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "CustomFindOptions" }, "704": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.resolve" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "CustomFindOptions.select" }, "705": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.options" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "CustomFindOptions.where" }, "706": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.alias" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "CustomFindOptions.order" }, "707": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.main" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "CustomFindOptions.skip" }, "708": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ExternalModuleDeclaration" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "CustomFindOptions.take" }, "709": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "CustomFindOptions.TModel" }, "710": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.scope" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "CustomFindOptions.InKeys" }, "711": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.definition" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "QueryConfig" }, "712": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.server" - }, - "713": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "sourceFileName": "../../../packages/types/src/common/common.ts", "qualifiedName": "__type" }, + "713": { + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.defaultFields" + }, "714": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.defaultRelations" }, "715": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.url" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.allowedFields" }, "716": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.keepAlive" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.allowedRelations" }, "717": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.options" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.defaultLimit" }, "718": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.alias" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.isList" }, "719": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.main" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "TEntity" }, "720": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModuleResolution" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "RequestQueryFields" }, "721": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "sourceFileName": "../../../packages/types/src/common/common.ts", "qualifiedName": "__type" }, "722": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.resolutionPath" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.expand" }, "723": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.definition" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.fields" }, "724": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.options" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.offset" }, "725": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.dependencies" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.limit" }, "726": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.moduleDeclaration" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.order" }, "727": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.moduleExports" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "PaginatedResponse" }, "728": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModuleDefinition" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type" }, "729": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.limit" }, "730": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.key" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.offset" }, "731": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.registrationName" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.count" }, "732": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.defaultPackage" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "DeleteResponse" }, "733": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.label" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type" }, "734": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.canOverride" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.id" }, "735": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.isRequired" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.object" }, "736": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.isQueryable" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "__type.deleted" }, "737": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.isLegacy" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "EmptyQueryParams" }, "738": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.dependencies" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "RepositoryTransformOptions" }, "739": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.defaultModuleDeclaration" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "DateComparisonOperator" }, "740": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "LinkModuleDefinition" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "DateComparisonOperator.lt" }, "741": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "DateComparisonOperator.gt" }, "742": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.key" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "DateComparisonOperator.gte" }, "743": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.registrationName" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "DateComparisonOperator.lte" }, "744": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.label" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "StringComparisonOperator" }, "745": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.dependencies" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "StringComparisonOperator.lt" }, "746": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.defaultModuleDeclaration" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "StringComparisonOperator.gt" }, "747": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModuleConfig" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "StringComparisonOperator.gte" }, "748": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "StringComparisonOperator.lte" }, "749": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.module" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "StringComparisonOperator.contains" }, "750": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.path" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "StringComparisonOperator.starts_with" }, "751": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.definition" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "StringComparisonOperator.ends_with" }, "752": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "LoadedModule" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "NumericalComparisonOperator" }, "753": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "NumericalComparisonOperator.lt" }, "754": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.__joinerConfig" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "NumericalComparisonOperator.gt" }, "755": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.__definition" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "NumericalComparisonOperator.gte" }, "756": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "LoaderOptions" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "NumericalComparisonOperator.lte" }, "757": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressPayload" }, "758": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.container" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressPayload.first_name" }, "759": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.options" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressPayload.last_name" }, "760": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.logger" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressPayload.phone" }, "761": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "TOptions" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressPayload.metadata" }, "762": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModuleLoaderFunction" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressPayload.company" }, "763": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressPayload.address_1" }, "764": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressPayload.address_2" }, "765": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "options" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressPayload.city" }, "766": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "moduleDeclaration" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressPayload.country_code" }, "767": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModulesResponse" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressPayload.province" }, "768": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressPayload.postal_code" }, "769": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.module" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressCreatePayload" }, "770": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.resolution" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressCreatePayload.first_name" }, "771": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModuleJoinerConfig" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressCreatePayload.last_name" }, "772": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressCreatePayload.phone" }, "773": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.schema" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressCreatePayload.metadata" }, "774": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.relationships" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressCreatePayload.company" }, "775": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.extends" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressCreatePayload.address_1" }, "776": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressCreatePayload.address_2" }, "777": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.serviceName" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressCreatePayload.city" }, "778": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.fieldAlias" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressCreatePayload.country_code" }, "779": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressCreatePayload.province" }, "780": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.path" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "AddressCreatePayload.postal_code" }, "781": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.forwardArgumentsOnPath" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindParams" }, "782": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.relationship" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindParams.expand" }, "783": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.serviceName" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindParams.fields" }, "784": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.primaryKeys" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindPaginationParams" }, "785": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.isLink" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindPaginationParams.offset" }, "786": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.linkableKeys" + "sourceFileName": "../../../packages/types/src/common/common.ts", + "qualifiedName": "FindPaginationParams.limit" }, "787": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.isReadOnlyLink" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "HttpCompressionOptions" }, "788": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.databaseConfig" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.enabled" }, "789": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.level" }, "790": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.tableName" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.memLevel" }, "791": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.idPrefix" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.threshold" }, "792": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.extraFields" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "ProjectConfigOptions" }, "793": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.store_cors" }, "794": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.type" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.admin_cors" }, "795": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.defaultValue" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.cookie_secret" }, "796": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.nullable" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.jwt_secret" }, "797": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.options" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_database" }, "798": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModuleJoinerRelationship" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_url" }, "799": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_schema" }, "800": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.isInternalService" - }, - "801": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.deleteCascade" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_logging" }, "802": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModuleExports" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_extra" }, "803": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "sourceFileName": "../../../packages/types/src/common/config-module.ts", "qualifiedName": "__type" }, "804": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.service" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.ssl" }, "805": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.loaders" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type" }, "806": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.migrations" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.rejectUnauthorized" }, "807": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.models" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.redis_url" }, "808": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.runMigrations" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.redis_prefix" }, "809": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.runMigrations" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.redis_options" }, "810": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "options" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.session_options" }, "811": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "moduleDeclaration" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.http_compression" }, "812": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.revertMigration" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "ConfigModule" }, "813": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.revertMigration" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.projectConfig" }, "814": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "options" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.plugins" }, "815": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "moduleDeclaration" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type" }, "816": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModuleServiceInitializeOptions" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.resolve" }, "817": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModuleServiceInitializeOptions.database" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.options" }, "818": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.modules" }, "819": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.connection" + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.featureFlags" }, "820": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.clientUrl" + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "MedusaContainer" }, "821": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.schema" - }, - "822": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.host" - }, - "823": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.port" - }, - "824": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.user" - }, - "825": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.password" - }, - "826": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.database" - }, - "827": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.driverOptions" - }, - "828": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.debug" - }, - "829": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.pool" - }, - "830": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModuleServiceInitializeCustomDataLayerOptions" + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "__type" }, "831": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "ContainerLike" }, "832": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.manager" + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "__type" }, "833": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.repositories" + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "__type.resolve" }, "834": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "__type.resolve" }, "835": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.__index" + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "T" + }, + "836": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "key" }, "837": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModuleBootstrapDeclaration" + "sourceFileName": "../../../packages/types/src/customer/index.ts", + "qualifiedName": "" }, "838": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "RemoteQueryFunction" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO" }, "839": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.id" }, "840": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.email" }, "841": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "query" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.billing_address_id" }, "842": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "variables" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.shipping_address_id" }, "843": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "IModuleService" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.first_name" }, "844": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "IModuleService.__joinerConfig" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.last_name" }, "845": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "IModuleService.__joinerConfig" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.billing_address" }, "846": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "IModuleService.__hooks" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.shipping_address" }, "847": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.phone" }, "848": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.onApplicationStart" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.has_account" }, "849": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.groups" }, "850": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "sourceFileName": "../../../packages/types/src/customer/common.ts", "qualifiedName": "__type" }, "851": { - "sourceFileName": "../../../packages/types/src/promotion/index.ts", - "qualifiedName": "" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "__type.id" }, "852": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "ApplicationMethodTypeValues" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.orders" }, "853": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "ApplicationMethodTargetTypeValues" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "__type" }, "854": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "ApplicationMethodAllocationValues" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "__type.id" }, "855": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "ApplicationMethodDTO" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.metadata" }, "856": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "ApplicationMethodDTO.id" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.deleted_at" }, "857": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "ApplicationMethodDTO.type" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.created_at" }, "858": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "ApplicationMethodDTO.target_type" + "sourceFileName": "../../../packages/types/src/customer/common.ts", + "qualifiedName": "CustomerDTO.updated_at" }, "859": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "ApplicationMethodDTO.allocation" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "" }, "860": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "ApplicationMethodDTO.value" + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "FilterQuery" }, "861": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "ApplicationMethodDTO.max_quantity" + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type" }, "862": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "ApplicationMethodDTO.promotion" - }, - "863": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "ApplicationMethodDTO.target_rules" + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.__index" }, "864": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "CreateApplicationMethodDTO" + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "T" }, "865": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "CreateApplicationMethodDTO.type" + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "Prev" }, "866": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "CreateApplicationMethodDTO.target_type" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable" }, "867": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "CreateApplicationMethodDTO.allocation" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" }, "868": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "CreateApplicationMethodDTO.value" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" }, "869": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "CreateApplicationMethodDTO.max_quantity" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.T" }, "870": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "CreateApplicationMethodDTO.promotion" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "OptionsQuery" }, "871": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "CreateApplicationMethodDTO.target_rules" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "OptionsQuery.populate" }, "872": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "UpdateApplicationMethodDTO" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "OptionsQuery.orderBy" }, "873": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "UpdateApplicationMethodDTO.id" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "OptionsQuery.limit" }, "874": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "UpdateApplicationMethodDTO.type" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "OptionsQuery.offset" }, "875": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "UpdateApplicationMethodDTO.target_type" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "OptionsQuery.fields" }, "876": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "UpdateApplicationMethodDTO.allocation" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "OptionsQuery.groupBy" }, "877": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "UpdateApplicationMethodDTO.value" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "OptionsQuery.filters" }, "878": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "UpdateApplicationMethodDTO.max_quantity" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "OptionsQuery.T" }, "879": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "UpdateApplicationMethodDTO.promotion" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "OptionsQuery.P" }, "880": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "FilterableApplicationMethodProps" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "FindOptions" }, "881": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "FilterableApplicationMethodProps.id" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "__type" }, "882": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "FilterableApplicationMethodProps.type" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "__type.where" }, "883": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "FilterableApplicationMethodProps.target_type" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "__type.options" }, "884": { - "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", - "qualifiedName": "FilterableApplicationMethodProps.allocation" + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "T" }, "885": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService" }, "886": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.find" }, "887": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "PromotionType" + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.find" }, "888": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "PromotionDTO" + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "options" }, "889": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "PromotionDTO.id" - }, - "890": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "PromotionDTO.code" - }, - "891": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "PromotionDTO.type" - }, - "892": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "PromotionDTO.is_automatic" - }, - "893": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "PromotionDTO.application_method" - }, - "894": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "CreatePromotionDTO" - }, - "895": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "CreatePromotionDTO.code" - }, - "896": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "CreatePromotionDTO.type" - }, - "897": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "CreatePromotionDTO.is_automatic" - }, - "898": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "CreatePromotionDTO.application_method" - }, - "899": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "CreatePromotionDTO.rules" - }, - "900": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "UpdatePromotionDTO" - }, - "901": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "UpdatePromotionDTO.id" - }, - "902": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "UpdatePromotionDTO.is_automatic" - }, - "903": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "UpdatePromotionDTO.code" - }, - "904": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "UpdatePromotionDTO.type" - }, - "905": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "UpdatePromotionDTO.application_method" - }, - "906": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "FilterablePromotionProps" - }, - "907": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "FilterablePromotionProps.id" - }, - "908": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "FilterablePromotionProps.code" - }, - "909": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "FilterablePromotionProps.is_automatic" - }, - "910": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", - "qualifiedName": "FilterablePromotionProps.type" - }, - "911": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "912": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "913": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "PromotionRuleOperatorValues" - }, - "914": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "PromotionRuleDTO" - }, - "915": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "PromotionRuleDTO.id" - }, - "916": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "CreatePromotionRuleDTO" - }, - "917": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "CreatePromotionRuleDTO.description" - }, - "918": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "CreatePromotionRuleDTO.attribute" - }, - "919": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "CreatePromotionRuleDTO.operator" - }, - "920": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "CreatePromotionRuleDTO.values" - }, - "921": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "UpdatePromotionRuleDTO" - }, - "922": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "UpdatePromotionRuleDTO.id" - }, - "923": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "RemovePromotionRuleDTO" - }, - "924": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "RemovePromotionRuleDTO.id" - }, - "925": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "FilterablePromotionRuleProps" - }, - "926": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", - "qualifiedName": "FilterablePromotionRuleProps.id" - }, - "927": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "928": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "929": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", - "qualifiedName": "PromotionRuleValueDTO" - }, - "930": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", - "qualifiedName": "PromotionRuleValueDTO.id" - }, - "931": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", - "qualifiedName": "CreatePromotionRuleValueDTO" - }, - "932": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", - "qualifiedName": "CreatePromotionRuleValueDTO.value" - }, - "933": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", - "qualifiedName": "CreatePromotionRuleValueDTO.promotion_rule" - }, - "934": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", - "qualifiedName": "UpdatePromotionRuleValueDTO" - }, - "935": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", - "qualifiedName": "UpdatePromotionRuleValueDTO.id" - }, - "936": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", - "qualifiedName": "FilterablePromotionRuleValueProps" - }, - "937": { - "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", - "qualifiedName": "FilterablePromotionRuleValueProps.id" - }, - "938": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "939": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "940": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService" - }, - "941": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.create" - }, - "942": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.create" - }, - "943": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "data" - }, - "944": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "sharedContext" - }, - "945": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.update" - }, - "946": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.update" - }, - "947": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "data" - }, - "948": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "sharedContext" - }, - "949": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.list" - }, - "950": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.list" - }, - "951": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "filters" - }, - "952": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "config" - }, - "953": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "sharedContext" - }, - "954": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.retrieve" - }, - "955": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.retrieve" - }, - "956": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "id" - }, - "957": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "config" - }, - "958": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "sharedContext" - }, - "959": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.delete" - }, - "960": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.delete" - }, - "961": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "ids" - }, - "962": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "sharedContext" - }, - "963": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.addPromotionRules" - }, - "964": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.addPromotionRules" - }, - "965": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "promotionId" - }, - "966": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "rulesData" - }, - "967": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "sharedContext" - }, - "968": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.addPromotionTargetRules" - }, - "969": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.addPromotionTargetRules" - }, - "970": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "promotionId" - }, - "971": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "rulesData" - }, - "972": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "sharedContext" - }, - "973": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.removePromotionRules" - }, - "974": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.removePromotionRules" - }, - "975": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "promotionId" - }, - "976": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "rulesData" - }, - "977": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "sharedContext" - }, - "978": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.removePromotionTargetRules" - }, - "979": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "IPromotionModuleService.removePromotionTargetRules" - }, - "980": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "promotionId" - }, - "981": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "rulesData" - }, - "982": { - "sourceFileName": "../../../packages/types/src/promotion/service.ts", - "qualifiedName": "sharedContext" - }, - "983": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "IModuleService.__joinerConfig" - }, - "984": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "IModuleService.__joinerConfig" - }, - "985": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "IModuleService.__hooks" - }, - "986": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" - }, - "987": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type.onApplicationStart" - }, - "988": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" - }, - "989": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "__type" - }, - "990": { - "sourceFileName": "../../../packages/types/src/region/index.ts", - "qualifiedName": "" - }, - "991": { - "sourceFileName": "../../../packages/types/src/region/common.ts", - "qualifiedName": "RegionDTO" - }, - "992": { - "sourceFileName": "../../../packages/types/src/region/common.ts", - "qualifiedName": "__type" - }, - "993": { - "sourceFileName": "../../../packages/types/src/region/common.ts", - "qualifiedName": "__type.name" - }, - "994": { - "sourceFileName": "../../../packages/types/src/region/common.ts", - "qualifiedName": "__type.currency_code" - }, - "995": { - "sourceFileName": "../../../packages/types/src/region/common.ts", - "qualifiedName": "__type.tax_rate" - }, - "996": { - "sourceFileName": "../../../packages/types/src/region/common.ts", - "qualifiedName": "__type.tax_code" - }, - "997": { - "sourceFileName": "../../../packages/types/src/region/common.ts", - "qualifiedName": "__type.gift_cards_taxable" - }, - "998": { - "sourceFileName": "../../../packages/types/src/region/common.ts", - "qualifiedName": "__type.automatic_taxes" - }, - "999": { - "sourceFileName": "../../../packages/types/src/region/common.ts", - "qualifiedName": "__type.tax_provider_id" - }, - "1000": { - "sourceFileName": "../../../packages/types/src/region/common.ts", - "qualifiedName": "__type.metadata" - }, - "1001": { - "sourceFileName": "../../../packages/types/src/region/common.ts", - "qualifiedName": "__type.includes_tax" - }, - "1002": { - "sourceFileName": "../../../packages/types/src/sales-channel/index.ts", - "qualifiedName": "" - }, - "1003": { - "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", - "qualifiedName": "SalesChannelLocationDTO" - }, - "1004": { - "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", - "qualifiedName": "SalesChannelLocationDTO.sales_channel_id" - }, - "1005": { - "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", - "qualifiedName": "SalesChannelLocationDTO.location_id" - }, - "1006": { - "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", - "qualifiedName": "SalesChannelLocationDTO.sales_channel" - }, - "1007": { - "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", - "qualifiedName": "SalesChannelDTO" - }, - "1008": { - "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", - "qualifiedName": "SalesChannelDTO.id" - }, - "1009": { - "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", - "qualifiedName": "SalesChannelDTO.description" - }, - "1010": { - "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", - "qualifiedName": "SalesChannelDTO.is_disabled" - }, - "1011": { - "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", - "qualifiedName": "SalesChannelDTO.metadata" - }, - "1012": { - "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", - "qualifiedName": "SalesChannelDTO.locations" - }, - "1013": { - "sourceFileName": "../../../packages/types/src/search/index.ts", - "qualifiedName": "" - }, - "1014": { - "sourceFileName": "../../../packages/types/src/search/index.ts", - "qualifiedName": "IndexSettings" - }, - "1015": { - "sourceFileName": "../../../packages/types/src/search/index.ts", - "qualifiedName": "__type" - }, - "1016": { - "sourceFileName": "../../../packages/types/src/search/index.ts", - "qualifiedName": "__type.indexSettings" - }, - "1017": { - "sourceFileName": "../../../packages/types/src/search/index.ts", - "qualifiedName": "__type.primaryKey" - }, - "1018": { - "sourceFileName": "../../../packages/types/src/search/index.ts", - "qualifiedName": "__type.transformer" - }, - "1019": { - "sourceFileName": "../../../packages/types/src/search/index.ts", - "qualifiedName": "__type" - }, - "1020": { - "sourceFileName": "../../../packages/types/src/search/index.ts", - "qualifiedName": "__type" - }, - "1021": { - "sourceFileName": "../../../packages/types/src/search/index.ts", - "qualifiedName": "document" - }, - "1022": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService" - }, - "1023": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.options" - }, - "1024": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.createIndex" - }, - "1025": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.createIndex" - }, - "1026": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "indexName" - }, - "1027": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "options" - }, - "1028": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.getIndex" - }, - "1029": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.getIndex" - }, - "1030": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "indexName" - }, - "1031": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.addDocuments" - }, - "1032": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.addDocuments" - }, - "1033": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "indexName" - }, - "1034": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "documents" - }, - "1035": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "type" - }, - "1036": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.replaceDocuments" - }, - "1037": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.replaceDocuments" - }, - "1038": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "indexName" - }, - "1039": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "documents" - }, - "1040": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "type" - }, - "1041": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.deleteDocument" - }, - "1042": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.deleteDocument" - }, - "1043": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "indexName" - }, - "1044": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "document_id" - }, - "1045": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.deleteAllDocuments" - }, - "1046": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.deleteAllDocuments" - }, - "1047": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "indexName" - }, - "1048": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.search" - }, - "1049": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.search" - }, - "1050": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "indexName" - }, - "1051": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "query" - }, - "1052": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "options" - }, - "1053": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.updateSettings" - }, - "1054": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "ISearchService.updateSettings" - }, - "1055": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "indexName" - }, - "1056": { - "sourceFileName": "../../../packages/types/src/search/interface.ts", - "qualifiedName": "settings" - }, - "1057": { - "sourceFileName": "../../../packages/types/src/transaction-base/index.ts", - "qualifiedName": "" - }, - "1058": { - "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", - "qualifiedName": "ITransactionBaseService" - }, - "1059": { - "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", - "qualifiedName": "ITransactionBaseService.withTransaction" - }, - "1060": { - "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", - "qualifiedName": "ITransactionBaseService.withTransaction" - }, - "1061": { - "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", - "qualifiedName": "transactionManager" - }, - "1062": { - "sourceFileName": "../../../packages/types/src/workflow/index.ts", - "qualifiedName": "" - }, - "1063": { - "sourceFileName": "../../../packages/types/src/workflow/cart/index.ts", - "qualifiedName": "" - }, - "1064": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateLineItemInputDTO" - }, - "1065": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateLineItemInputDTO.variant_id" - }, - "1066": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateLineItemInputDTO.quantity" - }, - "1067": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateCartWorkflowInputDTO" - }, - "1068": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateCartWorkflowInputDTO.region_id" - }, - "1069": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateCartWorkflowInputDTO.country_code" - }, - "1070": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateCartWorkflowInputDTO.items" - }, - "1071": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateCartWorkflowInputDTO.context" - }, - "1072": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateCartWorkflowInputDTO.sales_channel_id" - }, - "1073": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateCartWorkflowInputDTO.shipping_address_id" - }, - "1074": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateCartWorkflowInputDTO.billing_address_id" - }, - "1075": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateCartWorkflowInputDTO.billing_address" - }, - "1076": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateCartWorkflowInputDTO.shipping_address" - }, - "1077": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateCartWorkflowInputDTO.customer_id" - }, - "1078": { - "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", - "qualifiedName": "CreateCartWorkflowInputDTO.email" - }, - "1079": { - "sourceFileName": "../../../packages/types/src/workflow/common.ts", - "qualifiedName": "" - }, - "1080": { - "sourceFileName": "../../../packages/types/src/workflow/common.ts", - "qualifiedName": "WorkflowInputConfig" - }, - "1081": { - "sourceFileName": "../../../packages/types/src/workflow/common.ts", - "qualifiedName": "WorkflowInputConfig.listConfig" - }, - "1082": { - "sourceFileName": "../../../packages/types/src/workflow/common.ts", - "qualifiedName": "__type" - }, - "1083": { - "sourceFileName": "../../../packages/types/src/workflow/common.ts", - "qualifiedName": "__type.select" - }, - "1084": { - "sourceFileName": "../../../packages/types/src/workflow/common.ts", - "qualifiedName": "__type.relations" - }, - "1085": { - "sourceFileName": "../../../packages/types/src/workflow/common.ts", - "qualifiedName": "WorkflowInputConfig.retrieveConfig" - }, - "1086": { - "sourceFileName": "../../../packages/types/src/workflow/common.ts", - "qualifiedName": "__type" - }, - "1087": { - "sourceFileName": "../../../packages/types/src/workflow/common.ts", - "qualifiedName": "__type.select" - }, - "1088": { - "sourceFileName": "../../../packages/types/src/workflow/common.ts", - "qualifiedName": "__type.relations" - }, - "1089": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/index.ts", - "qualifiedName": "" - }, - "1090": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListDTO" - }, - "1091": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListDTO.starts_at" - }, - "1092": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListDTO.ends_at" - }, - "1093": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListDTO.status" - }, - "1094": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListDTO.rules_count" - }, - "1095": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListDTO.rules" - }, - "1096": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListDTO.prices" - }, - "1097": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "__type" - }, - "1098": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "__type.amount" - }, - "1099": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "__type.currency_code" - }, - "1100": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "__type.region_id" - }, - "1101": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "__type.max_quantity" - }, - "1102": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "__type.min_quantity" - }, - "1103": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListDTO.customer_groups" - }, - "1104": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "__type" - }, - "1105": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "__type.id" - }, - "1106": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListRuleDTO" - }, - "1107": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListRuleDTO.rule_attribute" - }, - "1108": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListRuleDTO.value" - }, - "1109": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListPriceDTO" - }, - "1110": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListPriceDTO.amount" - }, - "1111": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListPriceDTO.currency_code" - }, - "1112": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListPriceDTO.price_set_id" - }, - "1113": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListPriceDTO.region_id" - }, - "1114": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListPriceDTO.max_quantity" - }, - "1115": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListPriceDTO.min_quantity" - }, - "1116": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowInputDTO" - }, - "1117": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowInputDTO.price_lists" - }, - "1118": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "RemovePriceListProductsWorkflowInputDTO" - }, - "1119": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "RemovePriceListProductsWorkflowInputDTO.product_ids" - }, - "1120": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "RemovePriceListProductsWorkflowInputDTO.price_list_id" - }, - "1121": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "RemovePriceListVariantsWorkflowInputDTO" - }, - "1122": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "RemovePriceListVariantsWorkflowInputDTO.variant_ids" - }, - "1123": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "RemovePriceListVariantsWorkflowInputDTO.price_list_id" - }, - "1124": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "RemovePriceListPricesWorkflowInputDTO" - }, - "1125": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "RemovePriceListPricesWorkflowInputDTO.money_amount_ids" - }, - "1126": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "RemovePriceListPricesWorkflowInputDTO.price_list_id" - }, - "1127": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowDTO" - }, - "1128": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowDTO.title" - }, - "1129": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowDTO.name" - }, - "1130": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowDTO.description" - }, - "1131": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowDTO.type" - }, - "1132": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowDTO.starts_at" - }, - "1133": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowDTO.ends_at" - }, - "1134": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowDTO.status" - }, - "1135": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowDTO.rules_count" - }, - "1136": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowDTO.prices" - }, - "1137": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "CreatePriceListWorkflowDTO.rules" - }, - "1138": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "PriceListVariantPriceDTO" - }, - "1139": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "__type" - }, - "1140": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "__type.variant_id" - }, - "1141": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "__type.price_set_id" - }, - "1142": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "UpdatePriceListWorkflowDTO" - }, - "1143": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "UpdatePriceListWorkflowDTO.id" - }, - "1144": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "UpdatePriceListWorkflowDTO.name" - }, - "1145": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "UpdatePriceListWorkflowDTO.starts_at" - }, - "1146": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "UpdatePriceListWorkflowDTO.ends_at" - }, - "1147": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "UpdatePriceListWorkflowDTO.status" - }, - "1148": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "UpdatePriceListWorkflowDTO.rules" - }, - "1149": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "UpdatePriceListWorkflowDTO.prices" - }, - "1150": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "UpdatePriceListWorkflowDTO.customer_groups" - }, - "1151": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "__type" - }, - "1152": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "__type.id" - }, - "1153": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "UpdatePriceListWorkflowInputDTO" - }, - "1154": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", - "qualifiedName": "UpdatePriceListWorkflowInputDTO.price_lists" - }, - "1155": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/remove-price-list.ts", - "qualifiedName": "RemovePriceListWorkflowInputDTO" - }, - "1156": { - "sourceFileName": "../../../packages/types/src/workflow/price-list/remove-price-list.ts", - "qualifiedName": "RemovePriceListWorkflowInputDTO.price_lists" - }, - "1157": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "FileServiceUploadResult" - }, - "1158": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type" - }, - "1159": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.url" - }, - "1160": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.key" - }, - "1161": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "FileServiceGetUploadStreamResult" - }, - "1162": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type" - }, - "1163": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.writeStream" - }, - "1164": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.promise" - }, - "1165": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.url" - }, - "1166": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.fileKey" - }, - "1167": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.__index" - }, - "1169": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "GetUploadedFileType" - }, - "1170": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type" - }, - "1171": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.fileKey" - }, - "1172": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.isPrivate" - }, - "1173": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.__index" - }, - "1175": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "DeleteFileType" - }, - "1176": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type" - }, - "1177": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.fileKey" - }, - "1178": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.__index" - }, - "1180": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "UploadStreamDescriptorType" - }, - "1181": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type" - }, - "1182": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.name" - }, - "1183": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.ext" - }, - "1184": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.isPrivate" - }, - "1185": { - "sourceFileName": "../../../packages/types/src/file-service/index.ts", - "qualifiedName": "__type.__index" - }, - "1187": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerRelationship" - }, - "1188": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type" - }, - "1189": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.alias" - }, - "1190": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.foreignKey" - }, - "1191": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.primaryKey" - }, - "1192": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.serviceName" - }, - "1193": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.isInternalService" - }, - "1194": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.inverse" - }, - "1195": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.isList" - }, - "1196": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.args" - }, - "1197": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerServiceConfigAlias" - }, - "1198": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerServiceConfigAlias.name" - }, - "1199": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerServiceConfigAlias.args" - }, - "1200": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerServiceConfig" - }, - "1201": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerServiceConfig.serviceName" - }, - "1202": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerServiceConfig.alias" - }, - "1203": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerServiceConfig.fieldAlias" - }, - "1204": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type" - }, - "1205": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.path" - }, - "1206": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.forwardArgumentsOnPath" - }, - "1207": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerServiceConfig.primaryKeys" - }, - "1208": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerServiceConfig.relationships" - }, - "1209": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerServiceConfig.extends" - }, - "1210": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type" - }, - "1211": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.serviceName" - }, - "1212": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.relationship" - }, - "1213": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerServiceConfig.args" - }, - "1214": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerArgument" - }, - "1215": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerArgument.name" - }, - "1216": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerArgument.value" - }, - "1217": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerDirective" - }, - "1218": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerDirective.name" - }, - "1219": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "JoinerDirective.value" - }, - "1220": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteJoinerQuery" - }, - "1221": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteJoinerQuery.service" - }, - "1222": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteJoinerQuery.alias" - }, - "1223": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteJoinerQuery.expands" - }, - "1224": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type" - }, - "1225": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.property" - }, - "1226": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.fields" - }, - "1227": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.args" - }, - "1228": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.directives" - }, - "1229": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type" - }, - "1230": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.__index" - }, - "1232": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteJoinerQuery.fields" - }, - "1233": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteJoinerQuery.args" - }, - "1234": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteJoinerQuery.directives" - }, - "1235": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type" - }, - "1236": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.__index" - }, - "1238": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteNestedExpands" - }, - "1239": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteNestedExpands.__index" - }, - "1241": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type" - }, - "1242": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.fields" - }, - "1243": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.args" - }, - "1244": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "__type.expands" - }, - "1245": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteExpandProperty" - }, - "1246": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteExpandProperty.property" - }, - "1247": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteExpandProperty.parent" - }, - "1248": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteExpandProperty.parentConfig" - }, - "1249": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteExpandProperty.serviceConfig" - }, - "1250": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteExpandProperty.fields" - }, - "1251": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteExpandProperty.args" - }, - "1252": { - "sourceFileName": "../../../packages/types/src/joiner/index.ts", - "qualifiedName": "RemoteExpandProperty.expands" - }, - "1253": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule" - }, - "1254": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.__joinerConfig" - }, - "1255": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.__joinerConfig" - }, - "1256": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.list" - }, - "1257": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.list" - }, - "1258": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "filters" - }, - "1259": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "config" - }, - "1260": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "sharedContext" - }, - "1261": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.listAndCount" - }, - "1262": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.listAndCount" - }, - "1263": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "filters" - }, - "1264": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "config" - }, - "1265": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "sharedContext" - }, - "1266": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.create" - }, - "1267": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.create" - }, - "1268": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "primaryKeyOrBulkData" - }, - "1269": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "foreignKeyData" - }, - "1270": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "sharedContext" - }, - "1271": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.dismiss" - }, - "1272": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.dismiss" - }, - "1273": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "primaryKeyOrBulkData" - }, - "1274": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "foreignKeyData" - }, - "1275": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "sharedContext" - }, - "1276": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.delete" - }, - "1277": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.delete" - }, - "1278": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "data" - }, - "1279": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "sharedContext" - }, - "1280": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.softDelete" - }, - "1281": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.softDelete" - }, - "1282": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "data" - }, - "1283": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "config" - }, - "1284": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "sharedContext" - }, - "1285": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.restore" - }, - "1286": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "ILinkModule.restore" - }, - "1287": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "data" - }, - "1288": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "config" - }, - "1289": { - "sourceFileName": "../../../packages/types/src/link-modules/index.ts", - "qualifiedName": "sharedContext" - }, - "1290": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "CurrencyDTO" - }, - "1291": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "CurrencyDTO.code" - }, - "1292": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "CurrencyDTO.symbol" - }, - "1293": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "CurrencyDTO.symbol_native" - }, - "1294": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "CurrencyDTO.name" - }, - "1295": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "CreateCurrencyDTO" - }, - "1296": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "CreateCurrencyDTO.code" - }, - "1297": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "CreateCurrencyDTO.symbol" - }, - "1298": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "CreateCurrencyDTO.symbol_native" - }, - "1299": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "CreateCurrencyDTO.name" - }, - "1300": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "UpdateCurrencyDTO" - }, - "1301": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "UpdateCurrencyDTO.code" - }, - "1302": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "UpdateCurrencyDTO.symbol" - }, - "1303": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "UpdateCurrencyDTO.symbol_native" - }, - "1304": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "UpdateCurrencyDTO.name" - }, - "1305": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "FilterableCurrencyProps" - }, - "1306": { - "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", - "qualifiedName": "FilterableCurrencyProps.code" - }, - "1307": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "1308": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "1309": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "MoneyAmountDTO" - }, - "1310": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "MoneyAmountDTO.id" - }, - "1311": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "MoneyAmountDTO.currency_code" - }, - "1312": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "MoneyAmountDTO.currency" - }, - "1313": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "MoneyAmountDTO.amount" - }, - "1314": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "MoneyAmountDTO.min_quantity" - }, - "1315": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "MoneyAmountDTO.max_quantity" - }, - "1316": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "MoneyAmountDTO.price_set_money_amount" - }, - "1317": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "MoneyAmountDTO.created_at" - }, - "1318": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "MoneyAmountDTO.updated_at" - }, - "1319": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "MoneyAmountDTO.deleted_at" - }, - "1320": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO" - }, - "1321": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.id" - }, - "1322": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.currency_code" - }, - "1323": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.currency" - }, - "1324": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.amount" - }, - "1325": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.min_quantity" - }, - "1326": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.max_quantity" - }, - "1327": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "UpdateMoneyAmountDTO" - }, - "1328": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "UpdateMoneyAmountDTO.id" - }, - "1329": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "UpdateMoneyAmountDTO.currency_code" - }, - "1330": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "UpdateMoneyAmountDTO.amount" - }, - "1331": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "UpdateMoneyAmountDTO.min_quantity" - }, - "1332": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "UpdateMoneyAmountDTO.max_quantity" - }, - "1333": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "FilterableMoneyAmountProps" - }, - "1334": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "FilterableMoneyAmountProps.id" - }, - "1335": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "FilterableMoneyAmountProps.currency_code" - }, - "1336": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "1337": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "1338": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO" - }, - "1339": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO.id" - }, - "1340": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO.price_set_id" - }, - "1341": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO.price_set" - }, - "1342": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO.rule_type_id" - }, - "1343": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO.rule_type" - }, - "1344": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO.value" - }, - "1345": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO.priority" - }, - "1346": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO.price_set_money_amount_id" - }, - "1347": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO.price_list_id" - }, - "1348": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO.created_at" - }, - "1349": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO.updated_at" - }, - "1350": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "PriceRuleDTO.deleted_at" - }, - "1351": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO" - }, - "1352": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.price_set_id" - }, - "1353": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.price_set" - }, - "1354": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.rule_type_id" - }, - "1355": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.rule_type" - }, - "1356": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.value" - }, - "1357": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.priority" - }, - "1358": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.price_set_money_amount_id" - }, - "1359": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "CreatePriceRuleDTO.price_set_money_amount" - }, - "1360": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO" - }, - "1361": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.id" - }, - "1362": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.price_set_id" - }, - "1363": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.rule_type_id" - }, - "1364": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.value" - }, - "1365": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.priority" - }, - "1366": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.price_set_money_amount_id" - }, - "1367": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "UpdatePriceRuleDTO.price_list_id" - }, - "1368": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "FilterablePriceRuleProps" - }, - "1369": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "FilterablePriceRuleProps.id" - }, - "1370": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "FilterablePriceRuleProps.name" - }, - "1371": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "FilterablePriceRuleProps.price_set_id" - }, - "1372": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", - "qualifiedName": "FilterablePriceRuleProps.rule_type_id" - }, - "1373": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "1374": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "1375": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "PricingRepositoryService" - }, - "1376": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "PricingRepositoryService.calculatePrices" - }, - "1377": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "PricingRepositoryService.calculatePrices" - }, - "1378": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "pricingFilters" - }, - "1379": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "pricingContext" - }, - "1380": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "1381": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "PricingContext" - }, - "1382": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "PricingContext.context" - }, - "1383": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "PricingFilters" - }, - "1384": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "PricingFilters.id" - }, - "1385": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "PriceSetDTO" - }, - "1386": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "PriceSetDTO.id" - }, - "1387": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "PriceSetDTO.money_amounts" - }, - "1388": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "PriceSetDTO.rule_types" - }, - "1389": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSetDTO" - }, - "1390": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSetDTO.id" - }, - "1391": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSetDTO.price_set_id" - }, - "1392": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSetDTO.amount" - }, - "1393": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSetDTO.currency_code" - }, - "1394": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSetDTO.min_quantity" - }, - "1395": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSetDTO.max_quantity" - }, - "1396": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSetDTO.price_list_type" - }, - "1397": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSetDTO.price_list_id" - }, - "1398": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSet" - }, - "1399": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSet.id" - }, - "1400": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSet.is_calculated_price_price_list" - }, - "1401": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSet.calculated_amount" - }, - "1402": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSet.is_original_price_price_list" - }, - "1403": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSet.original_amount" - }, - "1404": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSet.currency_code" - }, - "1405": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSet.calculated_price" - }, - "1406": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type" - }, - "1407": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type.money_amount_id" - }, - "1408": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type.price_list_id" - }, - "1409": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type.price_list_type" - }, - "1410": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type.min_quantity" - }, - "1411": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type.max_quantity" - }, - "1412": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CalculatedPriceSet.original_price" - }, - "1413": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type" - }, - "1414": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type.money_amount_id" - }, - "1415": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type.price_list_id" - }, - "1416": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type.price_list_type" - }, - "1417": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type.min_quantity" - }, - "1418": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type.max_quantity" - }, - "1419": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "AddRulesDTO" - }, - "1420": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "AddRulesDTO.priceSetId" - }, - "1421": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "AddRulesDTO.rules" - }, - "1422": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type" - }, - "1423": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type.attribute" - }, - "1424": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CreatePricesDTO" - }, - "1425": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CreatePricesDTO.rules" - }, - "1426": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.id" - }, - "1427": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.currency_code" - }, - "1428": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.currency" - }, - "1429": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.amount" - }, - "1430": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.min_quantity" - }, - "1431": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.max_quantity" - }, - "1432": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "AddPricesDTO" - }, - "1433": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "AddPricesDTO.priceSetId" - }, - "1434": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "AddPricesDTO.prices" - }, - "1435": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "RemovePriceSetRulesDTO" - }, - "1436": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "RemovePriceSetRulesDTO.id" - }, - "1437": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "RemovePriceSetRulesDTO.rules" - }, - "1438": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CreatePriceSetDTO" - }, - "1439": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CreatePriceSetDTO.rules" - }, - "1440": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type" - }, - "1441": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "__type.rule_attribute" - }, - "1442": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "CreatePriceSetDTO.prices" - }, - "1443": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "UpdatePriceSetDTO" - }, - "1444": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "UpdatePriceSetDTO.id" - }, - "1445": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "FilterablePriceSetProps" - }, - "1446": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "FilterablePriceSetProps.id" - }, - "1447": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", - "qualifiedName": "FilterablePriceSetProps.money_amounts" - }, - "1448": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "1449": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "1450": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "PriceSetMoneyAmountDTO" - }, - "1451": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "PriceSetMoneyAmountDTO.id" - }, - "1452": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "PriceSetMoneyAmountDTO.title" - }, - "1453": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "PriceSetMoneyAmountDTO.price_set" - }, - "1454": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "PriceSetMoneyAmountDTO.price_list" - }, - "1455": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "PriceSetMoneyAmountDTO.price_set_id" - }, - "1456": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "PriceSetMoneyAmountDTO.price_rules" - }, - "1457": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "PriceSetMoneyAmountDTO.money_amount" - }, - "1458": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "PriceSetMoneyAmountDTO.created_at" - }, - "1459": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "PriceSetMoneyAmountDTO.updated_at" - }, - "1460": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "PriceSetMoneyAmountDTO.deleted_at" - }, - "1461": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "UpdatePriceSetMoneyAmountDTO" - }, - "1462": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "UpdatePriceSetMoneyAmountDTO.id" - }, - "1463": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "UpdatePriceSetMoneyAmountDTO.title" - }, - "1464": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "UpdatePriceSetMoneyAmountDTO.price_set" - }, - "1465": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "UpdatePriceSetMoneyAmountDTO.money_amount" - }, - "1466": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "CreatePriceSetMoneyAmountDTO" - }, - "1467": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "CreatePriceSetMoneyAmountDTO.title" - }, - "1468": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "CreatePriceSetMoneyAmountDTO.price_set" - }, - "1469": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "CreatePriceSetMoneyAmountDTO.price_list" - }, - "1470": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "CreatePriceSetMoneyAmountDTO.money_amount" - }, - "1471": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "CreatePriceSetMoneyAmountDTO.rules_count" - }, - "1472": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "FilterablePriceSetMoneyAmountProps" - }, - "1473": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "FilterablePriceSetMoneyAmountProps.id" - }, - "1474": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "FilterablePriceSetMoneyAmountProps.price_set_id" - }, - "1475": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", - "qualifiedName": "FilterablePriceSetMoneyAmountProps.price_list_id" - }, - "1476": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "1477": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "1478": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "PriceSetMoneyAmountRulesDTO" - }, - "1479": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "PriceSetMoneyAmountRulesDTO.id" - }, - "1480": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "PriceSetMoneyAmountRulesDTO.price_set_money_amount" - }, - "1481": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "PriceSetMoneyAmountRulesDTO.rule_type" - }, - "1482": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "PriceSetMoneyAmountRulesDTO.value" - }, - "1483": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "CreatePriceSetMoneyAmountRulesDTO" - }, - "1484": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "CreatePriceSetMoneyAmountRulesDTO.price_set_money_amount" - }, - "1485": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "CreatePriceSetMoneyAmountRulesDTO.rule_type" - }, - "1486": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "CreatePriceSetMoneyAmountRulesDTO.value" - }, - "1487": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO" - }, - "1488": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO.id" - }, - "1489": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO.price_set_money_amount" - }, - "1490": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO.rule_type" - }, - "1491": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO.value" - }, - "1492": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps" - }, - "1493": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps.id" - }, - "1494": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps.rule_type_id" - }, - "1495": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps.price_set_money_amount_id" - }, - "1496": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", - "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps.value" - }, - "1497": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "1498": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "1499": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "PriceSetRuleTypeDTO" - }, - "1500": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "PriceSetRuleTypeDTO.id" - }, - "1501": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "PriceSetRuleTypeDTO.price_set" - }, - "1502": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "PriceSetRuleTypeDTO.rule_type" - }, - "1503": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "PriceSetRuleTypeDTO.value" - }, - "1504": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "CreatePriceSetRuleTypeDTO" - }, - "1505": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "CreatePriceSetRuleTypeDTO.price_set" - }, - "1506": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "CreatePriceSetRuleTypeDTO.rule_type" - }, - "1507": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "UpdatePriceSetRuleTypeDTO" - }, - "1508": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "UpdatePriceSetRuleTypeDTO.id" - }, - "1509": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "UpdatePriceSetRuleTypeDTO.price_set" - }, - "1510": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "UpdatePriceSetRuleTypeDTO.rule_type" - }, - "1511": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "FilterablePriceSetRuleTypeProps" - }, - "1512": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "FilterablePriceSetRuleTypeProps.id" - }, - "1513": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "FilterablePriceSetRuleTypeProps.rule_type_id" - }, - "1514": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", - "qualifiedName": "FilterablePriceSetRuleTypeProps.price_set_id" - }, - "1515": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "1516": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "1517": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "RuleTypeDTO" - }, - "1518": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "RuleTypeDTO.id" - }, - "1519": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "RuleTypeDTO.name" - }, - "1520": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "RuleTypeDTO.rule_attribute" - }, - "1521": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "RuleTypeDTO.default_priority" - }, - "1522": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "CreateRuleTypeDTO" - }, - "1523": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "CreateRuleTypeDTO.id" - }, - "1524": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "CreateRuleTypeDTO.name" - }, - "1525": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "CreateRuleTypeDTO.rule_attribute" - }, - "1526": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "CreateRuleTypeDTO.default_priority" - }, - "1527": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "UpdateRuleTypeDTO" - }, - "1528": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "UpdateRuleTypeDTO.id" - }, - "1529": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "UpdateRuleTypeDTO.name" - }, - "1530": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "UpdateRuleTypeDTO.rule_attribute" - }, - "1531": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "UpdateRuleTypeDTO.default_priority" - }, - "1532": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "FilterableRuleTypeProps" - }, - "1533": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "FilterableRuleTypeProps.id" - }, - "1534": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "FilterableRuleTypeProps.name" - }, - "1535": { - "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", - "qualifiedName": "FilterableRuleTypeProps.rule_attribute" - }, - "1536": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "1537": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "1538": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListStatus" - }, - "1539": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListStatus.ACTIVE" - }, - "1540": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListStatus.DRAFT" - }, - "1541": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListType" - }, - "1542": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListType.SALE" - }, - "1543": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListType.OVERRIDE" - }, - "1544": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO" - }, - "1545": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.id" - }, - "1546": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.title" - }, - "1547": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.starts_at" - }, - "1548": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.status" - }, - "1549": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.ends_at" - }, - "1550": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.rules_count" - }, - "1551": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.price_set_money_amounts" - }, - "1552": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.money_amounts" - }, - "1553": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.rule_types" - }, - "1554": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.rules" - }, - "1555": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListDTO.price_list_rules" - }, - "1556": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListPriceDTO" - }, - "1557": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListPriceDTO.price_set_id" - }, - "1558": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListPriceDTO.rules" - }, - "1559": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.id" - }, - "1560": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.currency_code" - }, - "1561": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.currency" - }, - "1562": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.amount" - }, - "1563": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.min_quantity" - }, - "1564": { - "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", - "qualifiedName": "CreateMoneyAmountDTO.max_quantity" - }, - "1565": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceSetPriceRules" - }, - "1566": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListRules" - }, - "1567": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListDTO" - }, - "1568": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListDTO.title" - }, - "1569": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListDTO.description" - }, - "1570": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListDTO.starts_at" - }, - "1571": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListDTO.ends_at" - }, - "1572": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListDTO.status" - }, - "1573": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListDTO.type" - }, - "1574": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListDTO.rules_count" - }, - "1575": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListDTO.rules" - }, - "1576": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListDTO.prices" - }, - "1577": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListDTO" - }, - "1578": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListDTO.id" - }, - "1579": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListDTO.title" - }, - "1580": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListDTO.description" - }, - "1581": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListDTO.starts_at" - }, - "1582": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListDTO.ends_at" - }, - "1583": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListDTO.status" - }, - "1584": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListDTO.rules_count" - }, - "1585": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListDTO.rules" - }, - "1586": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps" - }, - "1587": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps.id" - }, - "1588": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps.starts_at" - }, - "1589": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps.ends_at" - }, - "1590": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps.status" - }, - "1591": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListProps.rules_count" - }, - "1592": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "1593": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "1594": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListRuleProps" - }, - "1595": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListRuleProps.id" - }, - "1596": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListRuleProps.value" - }, - "1597": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListRuleProps.rule_type" - }, - "1598": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListRuleProps.price_list_id" - }, - "1599": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "1600": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "1601": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListRuleValueProps" - }, - "1602": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListRuleValueProps.id" - }, - "1603": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListRuleValueProps.value" - }, - "1604": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "FilterablePriceListRuleValueProps.price_list_rule_id" - }, - "1605": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$and" - }, - "1606": { - "sourceFileName": "../../../packages/types/src/dal/index.ts", - "qualifiedName": "BaseFilterable.$or" - }, - "1607": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListRuleDTO" - }, - "1608": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListRuleDTO.id" - }, - "1609": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListRuleDTO.value" - }, - "1610": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListRuleDTO.rule_type" - }, - "1611": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListRuleDTO.price_list" - }, - "1612": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListRuleDTO.price_list_rule_values" - }, - "1613": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListRuleDTO" - }, - "1614": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListRuleDTO.rule_type_id" - }, - "1615": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListRuleDTO.rule_type" - }, - "1616": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListRuleDTO.price_list_id" - }, - "1617": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListRuleDTO.price_list" - }, - "1618": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListRuleDTO" - }, - "1619": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListRuleDTO.id" - }, - "1620": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListRuleDTO.price_list_id" - }, - "1621": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListRuleDTO.rule_type_id" - }, - "1622": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListRuleDTO.price_list" - }, - "1623": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListRuleDTO.rule_type" - }, - "1624": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListRuleValueDTO" - }, - "1625": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListRuleValueDTO.id" - }, - "1626": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListRuleValueDTO.value" - }, - "1627": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "PriceListRuleValueDTO.price_list_rule" - }, - "1628": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListRuleValueDTO" - }, - "1629": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListRuleValueDTO.value" - }, - "1630": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListRuleValueDTO.price_list_rule_id" - }, - "1631": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "CreatePriceListRuleValueDTO.price_list_rule" - }, - "1632": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListRuleValueDTO" - }, - "1633": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListRuleValueDTO.id" - }, - "1634": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListRuleValueDTO.value" - }, - "1635": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "UpdatePriceListRuleValueDTO.price_list_rule_id" - }, - "1636": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "AddPriceListPricesDTO" - }, - "1637": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "AddPriceListPricesDTO.priceListId" - }, - "1638": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "AddPriceListPricesDTO.prices" - }, - "1639": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "SetPriceListRulesDTO" - }, - "1640": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "SetPriceListRulesDTO.priceListId" - }, - "1641": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "SetPriceListRulesDTO.rules" - }, - "1642": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "RemovePriceListRulesDTO" - }, - "1643": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "RemovePriceListRulesDTO.priceListId" - }, - "1644": { - "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", - "qualifiedName": "RemovePriceListRulesDTO.rules" - }, - "1645": { - "sourceFileName": "../../../packages/types/src/product-category/repository.ts", - "qualifiedName": "ProductCategoryTransformOptions" - }, - "1646": { - "sourceFileName": "../../../packages/types/src/product-category/repository.ts", - "qualifiedName": "ProductCategoryTransformOptions.includeDescendantsTree" - }, - "1647": { - "sourceFileName": "../../../packages/types/src/shared-context.ts", - "qualifiedName": "SharedContext" - }, - "1648": { - "sourceFileName": "../../../packages/types/src/shared-context.ts", - "qualifiedName": "__type.transactionManager" - }, - "1649": { - "sourceFileName": "../../../packages/types/src/shared-context.ts", - "qualifiedName": "__type.manager" - }, - "1650": { - "sourceFileName": "../../../packages/types/src/shared-context.ts", - "qualifiedName": "Context" - }, - "1651": { - "sourceFileName": "../../../packages/types/src/shared-context.ts", - "qualifiedName": "__type.transactionManager" - }, - "1652": { - "sourceFileName": "../../../packages/types/src/shared-context.ts", - "qualifiedName": "__type.manager" - }, - "1653": { - "sourceFileName": "../../../packages/types/src/shared-context.ts", - "qualifiedName": "__type.isolationLevel" - }, - "1654": { - "sourceFileName": "../../../packages/types/src/shared-context.ts", - "qualifiedName": "__type.enableNestedTransactions" - }, - "1655": { - "sourceFileName": "../../../packages/types/src/shared-context.ts", - "qualifiedName": "__type.transactionId" - }, - "1656": { - "sourceFileName": "../../../packages/types/src/shared-context.ts", - "qualifiedName": "TManager" - }, - "1657": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "SessionOptions" - }, - "1658": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type" - }, - "1659": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.name" - }, - "1660": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.resave" - }, - "1661": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.rolling" - }, - "1662": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.saveUninitialized" - }, - "1663": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.secret" - }, - "1664": { - "sourceFileName": "../../../packages/types/src/common/config-module.ts", - "qualifiedName": "__type.ttl" - }, - "1665": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "OperatorMap" - }, - "1666": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type" - }, - "1667": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$and" - }, - "1668": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$or" - }, - "1669": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$eq" - }, - "1670": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$ne" - }, - "1671": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$in" - }, - "1672": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$nin" - }, - "1673": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$not" - }, - "1674": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$gt" - }, - "1675": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$gte" - }, - "1676": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$lt" - }, - "1677": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$lte" - }, - "1678": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$like" - }, - "1679": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$re" - }, - "1680": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$ilike" - }, - "1681": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$fulltext" - }, - "1682": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$overlap" - }, - "1683": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$contains" - }, - "1684": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$contained" - }, - "1685": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.$exists" - }, - "1686": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "T" - }, - "1687": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "PrevLimit" - }, - "1688": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "Order" - }, - "1689": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "T" - }, - "1690": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "Dictionary" - }, - "1691": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type" - }, - "1692": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.__index" - }, - "1694": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "T" - }, - "1695": { + "890": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService" + "qualifiedName": "RepositoryService.findAndCount" }, - "1696": { + "891": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.findAndCount" + }, + "892": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "options" + }, + "893": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "context" + }, + "894": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.create" + }, + "895": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.create" + }, + "896": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "data" + }, + "897": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "context" + }, + "898": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.update" + }, + "899": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.update" + }, + "900": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "data" + }, + "901": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "context" + }, + "902": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.delete" + }, + "903": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.delete" + }, + "904": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "ids" + }, + "905": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "context" + }, + "906": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.softDelete" + }, + "907": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.softDelete" + }, + "908": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "ids" + }, + "909": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "context" + }, + "910": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.restore" + }, + "911": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RepositoryService.restore" + }, + "912": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "ids" + }, + "913": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "context" + }, + "914": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.transaction" }, - "1697": { + "915": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.transaction" }, - "1698": { + "916": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TManager" }, - "1699": { + "917": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "task" }, - "1700": { + "918": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type" }, - "1701": { + "919": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type" }, - "1702": { + "920": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "transactionManager" }, - "1703": { + "921": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "context" }, - "1704": { + "922": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type" }, - "1705": { + "923": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.isolationLevel" }, - "1706": { + "924": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.transaction" }, - "1707": { + "925": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "__type.enableNestedTransactions" }, - "1708": { + "926": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getFreshManager" }, - "1709": { + "927": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getFreshManager" }, - "1710": { + "928": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TManager" }, - "1711": { + "929": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getActiveManager" }, - "1712": { + "930": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.getActiveManager" }, - "1713": { + "931": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TManager" }, - "1714": { + "932": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.serialize" }, - "1715": { + "933": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "BaseRepositoryService.serialize" }, - "1716": { + "934": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "TOutput" }, - "1717": { + "935": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "data" }, - "1718": { + "936": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", "qualifiedName": "options" }, - "1719": { + "937": { "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", - "qualifiedName": "BaseRepositoryService.T" + "qualifiedName": "RepositoryService.T" + }, + "938": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TreeRepositoryService" + }, + "939": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TreeRepositoryService.find" + }, + "940": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TreeRepositoryService.find" + }, + "941": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "options" + }, + "942": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "transformOptions" + }, + "943": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "context" + }, + "944": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TreeRepositoryService.findAndCount" + }, + "945": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TreeRepositoryService.findAndCount" + }, + "946": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "options" + }, + "947": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "transformOptions" + }, + "948": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "context" + }, + "949": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TreeRepositoryService.create" + }, + "950": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TreeRepositoryService.create" + }, + "951": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "data" + }, + "952": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "context" + }, + "953": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TreeRepositoryService.delete" + }, + "954": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TreeRepositoryService.delete" + }, + "955": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "id" + }, + "956": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "context" + }, + "957": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.transaction" + }, + "958": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.transaction" + }, + "959": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TManager" + }, + "960": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "task" + }, + "961": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type" + }, + "962": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type" + }, + "963": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "transactionManager" + }, + "964": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "context" + }, + "965": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type" + }, + "966": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type.isolationLevel" + }, + "967": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type.transaction" + }, + "968": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type.enableNestedTransactions" + }, + "969": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.getFreshManager" + }, + "970": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.getFreshManager" + }, + "971": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TManager" + }, + "972": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.getActiveManager" + }, + "973": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.getActiveManager" + }, + "974": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TManager" + }, + "975": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.serialize" + }, + "976": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.serialize" + }, + "977": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TOutput" + }, + "978": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "data" + }, + "979": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "options" + }, + "980": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TreeRepositoryService.T" + }, + "981": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "SoftDeleteReturn" + }, + "982": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type.returnLinkableKeys" + }, + "983": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TReturnableLinkableKeys" + }, + "984": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "RestoreReturn" + }, + "985": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type.returnLinkableKeys" + }, + "986": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TReturnableLinkableKeys" + }, + "987": { + "sourceFileName": "../../../packages/types/src/dal/entity.ts", + "qualifiedName": "EntityDateColumns" + }, + "988": { + "sourceFileName": "../../../packages/types/src/dal/entity.ts", + "qualifiedName": "SoftDeletableEntityDateColumns" + }, + "989": { + "sourceFileName": "../../../packages/types/src/event-bus/index.ts", + "qualifiedName": "" + }, + "990": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "Subscriber" + }, + "991": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type" + }, + "992": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type" + }, + "993": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "data" + }, + "994": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "eventName" + }, + "995": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "T" + }, + "996": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "SubscriberContext" + }, + "997": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type" + }, + "998": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type.subscriberId" + }, + "999": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "SubscriberDescriptor" + }, + "1000": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type" + }, + "1001": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type.id" + }, + "1002": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type.subscriber" + }, + "1003": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "EventHandler" + }, + "1004": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type" + }, + "1005": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type" + }, + "1006": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "data" + }, + "1007": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "eventName" + }, + "1008": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "T" + }, + "1009": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "EmitData" + }, + "1010": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type" + }, + "1011": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type.eventName" + }, + "1012": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type.data" + }, + "1013": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "__type.options" + }, + "1014": { + "sourceFileName": "../../../packages/types/src/event-bus/common.ts", + "qualifiedName": "T" + }, + "1015": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "IEventBusService" + }, + "1016": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "IEventBusService.subscribe" + }, + "1017": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "IEventBusService.subscribe" + }, + "1018": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "eventName" + }, + "1019": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "subscriber" + }, + "1020": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "context" + }, + "1021": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "IEventBusService.unsubscribe" + }, + "1022": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "IEventBusService.unsubscribe" + }, + "1023": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "eventName" + }, + "1024": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "subscriber" + }, + "1025": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "context" + }, + "1026": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "IEventBusService.emit" + }, + "1027": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "IEventBusService.emit" + }, + "1028": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "T" + }, + "1029": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "event" + }, + "1030": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "data" + }, + "1031": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus.ts", + "qualifiedName": "options" + }, + "1032": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "ITransactionBaseService.withTransaction" + }, + "1033": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "ITransactionBaseService.withTransaction" + }, + "1034": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "transactionManager" + }, + "1035": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "IEventBusModuleService" + }, + "1036": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "IEventBusModuleService.emit" + }, + "1037": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "IEventBusModuleService.emit" + }, + "1038": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "T" + }, + "1039": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "eventName" + }, + "1040": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "data" + }, + "1041": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "options" + }, + "1042": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "IEventBusModuleService.emit" + }, + "1043": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "T" + }, + "1044": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "data" + }, + "1045": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "IEventBusModuleService.subscribe" + }, + "1046": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "IEventBusModuleService.subscribe" + }, + "1047": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "eventName" + }, + "1048": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "subscriber" + }, + "1049": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "context" + }, + "1050": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "IEventBusModuleService.unsubscribe" + }, + "1051": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "IEventBusModuleService.unsubscribe" + }, + "1052": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "eventName" + }, + "1053": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "subscriber" + }, + "1054": { + "sourceFileName": "../../../packages/types/src/event-bus/event-bus-module.ts", + "qualifiedName": "context" + }, + "1055": { + "sourceFileName": "../../../packages/types/src/feature-flag/index.ts", + "qualifiedName": "" + }, + "1056": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "IFlagRouter" + }, + "1057": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "IFlagRouter.isFeatureEnabled" + }, + "1058": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "__type" + }, + "1059": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "__type" + }, + "1060": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "key" + }, + "1061": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "IFlagRouter.listFlags" + }, + "1062": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "__type" + }, + "1063": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "__type" + }, + "1064": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "FeatureFlagsResponse" + }, + "1065": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "__type" + }, + "1066": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "__type.key" + }, + "1067": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "__type.value" + }, + "1068": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "FlagSettings" + }, + "1069": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "__type" + }, + "1070": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "__type.key" + }, + "1071": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "__type.description" + }, + "1072": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "__type.env_key" + }, + "1073": { + "sourceFileName": "../../../packages/types/src/feature-flag/common.ts", + "qualifiedName": "__type.default_val" + }, + "1074": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "" + }, + "1075": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger" + }, + "1076": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.panic" + }, + "1077": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1078": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1079": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "data" + }, + "1080": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.shouldLog" + }, + "1081": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1082": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1083": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "level" + }, + "1084": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.setLogLevel" + }, + "1085": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1086": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1087": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "level" + }, + "1088": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.unsetLogLevel" + }, + "1089": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1090": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1091": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.activity" + }, + "1092": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1093": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1094": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "message" + }, + "1095": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "config" + }, + "1096": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.progress" + }, + "1097": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1098": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1099": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "activityId" + }, + "1100": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "message" + }, + "1101": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.error" + }, + "1102": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1103": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1104": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "messageOrError" + }, + "1105": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "error" + }, + "1106": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.failure" + }, + "1107": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1108": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1109": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "activityId" + }, + "1110": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "message" + }, + "1111": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.success" + }, + "1112": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1113": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1114": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "activityId" + }, + "1115": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "message" + }, + "1116": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.debug" + }, + "1117": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1118": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1119": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "message" + }, + "1120": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.info" + }, + "1121": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1122": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1123": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "message" + }, + "1124": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.warn" + }, + "1125": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1126": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1127": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "message" + }, + "1128": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "Logger.log" + }, + "1129": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1130": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "__type" + }, + "1131": { + "sourceFileName": "../../../packages/types/src/logger/index.ts", + "qualifiedName": "args" + }, + "1132": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "" + }, + "1133": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "Constructor" + }, + "1134": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1135": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1136": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "args" + }, + "1137": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "T" + }, + "1138": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "LogLevel" + }, + "1139": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "LoggerOptions" + }, + "1140": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "MODULE_SCOPE" + }, + "1141": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "MODULE_SCOPE.INTERNAL" + }, + "1142": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "MODULE_SCOPE.EXTERNAL" + }, + "1143": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "MODULE_RESOURCE_TYPE" + }, + "1144": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "MODULE_RESOURCE_TYPE.SHARED" + }, + "1145": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "MODULE_RESOURCE_TYPE.ISOLATED" + }, + "1146": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "InternalModuleDeclaration" + }, + "1147": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1148": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.scope" + }, + "1149": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.resources" + }, + "1150": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.dependencies" + }, + "1151": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.definition" + }, + "1152": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.resolve" + }, + "1153": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.options" + }, + "1154": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.alias" + }, + "1155": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.main" + }, + "1156": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ExternalModuleDeclaration" + }, + "1157": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1158": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.scope" + }, + "1159": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.definition" + }, + "1160": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.server" + }, + "1161": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1162": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.type" + }, + "1163": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.url" + }, + "1164": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.keepAlive" + }, + "1165": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.options" + }, + "1166": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.alias" + }, + "1167": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.main" + }, + "1168": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModuleResolution" + }, + "1169": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1170": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.resolutionPath" + }, + "1171": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.definition" + }, + "1172": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.options" + }, + "1173": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.dependencies" + }, + "1174": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.moduleDeclaration" + }, + "1175": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.moduleExports" + }, + "1176": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModuleDefinition" + }, + "1177": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1178": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.key" + }, + "1179": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.registrationName" + }, + "1180": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.defaultPackage" + }, + "1181": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.label" + }, + "1182": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.canOverride" + }, + "1183": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.isRequired" + }, + "1184": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.isQueryable" + }, + "1185": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.isLegacy" + }, + "1186": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.dependencies" + }, + "1187": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.defaultModuleDeclaration" + }, + "1188": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "LinkModuleDefinition" + }, + "1189": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1190": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.key" + }, + "1191": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.registrationName" + }, + "1192": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.label" + }, + "1193": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.dependencies" + }, + "1194": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.defaultModuleDeclaration" + }, + "1195": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModuleConfig" + }, + "1196": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1197": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.module" + }, + "1198": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.path" + }, + "1199": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.definition" + }, + "1200": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "LoadedModule" + }, + "1201": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1202": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.__joinerConfig" + }, + "1203": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.__definition" + }, + "1204": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "LoaderOptions" + }, + "1205": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1206": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.container" + }, + "1207": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.options" + }, + "1208": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.logger" + }, + "1209": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "TOptions" + }, + "1210": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModuleLoaderFunction" + }, + "1211": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1212": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1213": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "options" + }, + "1214": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "moduleDeclaration" + }, + "1215": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModulesResponse" + }, + "1216": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1217": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.module" + }, + "1218": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.resolution" + }, + "1219": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModuleJoinerConfig" + }, + "1220": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1221": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.schema" + }, + "1222": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.relationships" + }, + "1223": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.extends" + }, + "1224": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1225": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.serviceName" + }, + "1226": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.fieldAlias" + }, + "1227": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1228": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.path" + }, + "1229": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.forwardArgumentsOnPath" + }, + "1230": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.relationship" + }, + "1231": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.serviceName" + }, + "1232": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.primaryKeys" + }, + "1233": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.isLink" + }, + "1234": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.linkableKeys" + }, + "1235": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.isReadOnlyLink" + }, + "1236": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.databaseConfig" + }, + "1237": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1238": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.tableName" + }, + "1239": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.idPrefix" + }, + "1240": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.extraFields" + }, + "1241": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1242": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.type" + }, + "1243": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.defaultValue" + }, + "1244": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.nullable" + }, + "1245": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.options" + }, + "1246": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModuleJoinerRelationship" + }, + "1247": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1248": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.isInternalService" + }, + "1249": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.deleteCascade" + }, + "1250": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModuleExports" + }, + "1251": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1252": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.service" + }, + "1253": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.loaders" + }, + "1254": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.migrations" + }, + "1255": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.models" + }, + "1256": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.runMigrations" + }, + "1257": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.runMigrations" + }, + "1258": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "options" + }, + "1259": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "moduleDeclaration" + }, + "1260": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.revertMigration" + }, + "1261": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.revertMigration" + }, + "1262": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "options" + }, + "1263": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "moduleDeclaration" + }, + "1264": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModuleServiceInitializeOptions" + }, + "1265": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModuleServiceInitializeOptions.database" + }, + "1266": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1267": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.connection" + }, + "1268": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.clientUrl" + }, + "1269": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.schema" + }, + "1270": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.host" + }, + "1271": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.port" + }, + "1272": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.user" + }, + "1273": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.password" + }, + "1274": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.database" + }, + "1275": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.driverOptions" + }, + "1276": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.debug" + }, + "1277": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.pool" + }, + "1278": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModuleServiceInitializeCustomDataLayerOptions" + }, + "1279": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1280": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.manager" + }, + "1281": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.repositories" + }, + "1282": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1283": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.__index" + }, + "1285": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModuleBootstrapDeclaration" + }, + "1286": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "RemoteQueryFunction" + }, + "1287": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1288": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1289": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "query" + }, + "1290": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "variables" + }, + "1291": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService" + }, + "1292": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService.__joinerConfig" + }, + "1293": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService.__joinerConfig" + }, + "1294": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService.__hooks" + }, + "1295": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1296": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.onApplicationStart" + }, + "1297": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1298": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1299": { + "sourceFileName": "../../../packages/types/src/promotion/index.ts", + "qualifiedName": "" + }, + "1300": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "ApplicationMethodTypeValues" + }, + "1301": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "ApplicationMethodTargetTypeValues" + }, + "1302": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "ApplicationMethodAllocationValues" + }, + "1303": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "ApplicationMethodDTO" + }, + "1304": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "ApplicationMethodDTO.id" + }, + "1305": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "ApplicationMethodDTO.type" + }, + "1306": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "ApplicationMethodDTO.target_type" + }, + "1307": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "ApplicationMethodDTO.allocation" + }, + "1308": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "ApplicationMethodDTO.value" + }, + "1309": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "ApplicationMethodDTO.max_quantity" + }, + "1310": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "ApplicationMethodDTO.promotion" + }, + "1311": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "ApplicationMethodDTO.target_rules" + }, + "1312": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "CreateApplicationMethodDTO" + }, + "1313": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "CreateApplicationMethodDTO.type" + }, + "1314": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "CreateApplicationMethodDTO.target_type" + }, + "1315": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "CreateApplicationMethodDTO.allocation" + }, + "1316": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "CreateApplicationMethodDTO.value" + }, + "1317": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "CreateApplicationMethodDTO.max_quantity" + }, + "1318": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "CreateApplicationMethodDTO.promotion" + }, + "1319": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "CreateApplicationMethodDTO.target_rules" + }, + "1320": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "UpdateApplicationMethodDTO" + }, + "1321": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "UpdateApplicationMethodDTO.id" + }, + "1322": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "UpdateApplicationMethodDTO.type" + }, + "1323": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "UpdateApplicationMethodDTO.target_type" + }, + "1324": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "UpdateApplicationMethodDTO.allocation" + }, + "1325": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "UpdateApplicationMethodDTO.value" + }, + "1326": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "UpdateApplicationMethodDTO.max_quantity" + }, + "1327": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "UpdateApplicationMethodDTO.promotion" + }, + "1328": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "FilterableApplicationMethodProps" + }, + "1329": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "FilterableApplicationMethodProps.id" + }, + "1330": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "FilterableApplicationMethodProps.type" + }, + "1331": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "FilterableApplicationMethodProps.target_type" + }, + "1332": { + "sourceFileName": "../../../packages/types/src/promotion/common/application-method.ts", + "qualifiedName": "FilterableApplicationMethodProps.allocation" + }, + "1333": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "1334": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "1335": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign.ts", + "qualifiedName": "CampaignDTO" + }, + "1336": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign.ts", + "qualifiedName": "CampaignDTO.id" + }, + "1337": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign.ts", + "qualifiedName": "CampaignDTO.name" + }, + "1338": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign.ts", + "qualifiedName": "CampaignDTO.description" + }, + "1339": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign.ts", + "qualifiedName": "CampaignDTO.currency" + }, + "1340": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign.ts", + "qualifiedName": "CampaignDTO.campaign_identifier" + }, + "1341": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign.ts", + "qualifiedName": "CampaignDTO.starts_at" + }, + "1342": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign.ts", + "qualifiedName": "CampaignDTO.ends_at" + }, + "1343": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign.ts", + "qualifiedName": "CampaignDTO.budget" + }, + "1344": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign.ts", + "qualifiedName": "FilterableCampaignProps" + }, + "1345": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign.ts", + "qualifiedName": "FilterableCampaignProps.id" + }, + "1346": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign.ts", + "qualifiedName": "FilterableCampaignProps.campaign_identifier" + }, + "1347": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "1348": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "1349": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign-budget.ts", + "qualifiedName": "CampaignBudgetTypeValues" + }, + "1350": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign-budget.ts", + "qualifiedName": "CampaignBudgetDTO" + }, + "1351": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign-budget.ts", + "qualifiedName": "CampaignBudgetDTO.id" + }, + "1352": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign-budget.ts", + "qualifiedName": "CampaignBudgetDTO.type" + }, + "1353": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign-budget.ts", + "qualifiedName": "CampaignBudgetDTO.limit" + }, + "1354": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign-budget.ts", + "qualifiedName": "CampaignBudgetDTO.used" + }, + "1355": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign-budget.ts", + "qualifiedName": "FilterableCampaignBudgetProps" + }, + "1356": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign-budget.ts", + "qualifiedName": "FilterableCampaignBudgetProps.id" + }, + "1357": { + "sourceFileName": "../../../packages/types/src/promotion/common/campaign-budget.ts", + "qualifiedName": "FilterableCampaignBudgetProps.type" + }, + "1358": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "1359": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "1360": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActions" + }, + "1361": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "UsageComputedActions" + }, + "1362": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "CampaignBudgetExceededAction" + }, + "1363": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "CampaignBudgetExceededAction.action" + }, + "1364": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "CampaignBudgetExceededAction.code" + }, + "1365": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "AddItemAdjustmentAction" + }, + "1366": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "AddItemAdjustmentAction.action" + }, + "1367": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "AddItemAdjustmentAction.item_id" + }, + "1368": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "AddItemAdjustmentAction.amount" + }, + "1369": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "AddItemAdjustmentAction.code" + }, + "1370": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "AddItemAdjustmentAction.description" + }, + "1371": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "RemoveItemAdjustmentAction" + }, + "1372": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "RemoveItemAdjustmentAction.action" + }, + "1373": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "RemoveItemAdjustmentAction.adjustment_id" + }, + "1374": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "RemoveItemAdjustmentAction.description" + }, + "1375": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "RemoveItemAdjustmentAction.code" + }, + "1376": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "AddShippingMethodAdjustment" + }, + "1377": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "AddShippingMethodAdjustment.action" + }, + "1378": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "AddShippingMethodAdjustment.shipping_method_id" + }, + "1379": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "AddShippingMethodAdjustment.amount" + }, + "1380": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "AddShippingMethodAdjustment.code" + }, + "1381": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "AddShippingMethodAdjustment.description" + }, + "1382": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "RemoveShippingMethodAdjustment" + }, + "1383": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "RemoveShippingMethodAdjustment.action" + }, + "1384": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "RemoveShippingMethodAdjustment.adjustment_id" + }, + "1385": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "RemoveShippingMethodAdjustment.code" + }, + "1386": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionAdjustmentLine" + }, + "1387": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionAdjustmentLine.id" + }, + "1388": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionAdjustmentLine.code" + }, + "1389": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionItemLine" + }, + "1390": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionItemLine.id" + }, + "1391": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionItemLine.quantity" + }, + "1392": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionItemLine.unit_price" + }, + "1393": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionItemLine.adjustments" + }, + "1394": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionShippingLine" + }, + "1395": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionShippingLine.id" + }, + "1396": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionShippingLine.unit_price" + }, + "1397": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionShippingLine.adjustments" + }, + "1398": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionContext" + }, + "1399": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionContext.items" + }, + "1400": { + "sourceFileName": "../../../packages/types/src/promotion/common/compute-actions.ts", + "qualifiedName": "ComputeActionContext.shipping_methods" + }, + "1401": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "PromotionType" + }, + "1402": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "PromotionDTO" + }, + "1403": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "PromotionDTO.id" + }, + "1404": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "PromotionDTO.code" + }, + "1405": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "PromotionDTO.type" + }, + "1406": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "PromotionDTO.is_automatic" + }, + "1407": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "PromotionDTO.application_method" + }, + "1408": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "PromotionDTO.rules" + }, + "1409": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "PromotionDTO.campaign" + }, + "1410": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "CreatePromotionDTO" + }, + "1411": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "CreatePromotionDTO.code" + }, + "1412": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "CreatePromotionDTO.type" + }, + "1413": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "CreatePromotionDTO.is_automatic" + }, + "1414": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "CreatePromotionDTO.application_method" + }, + "1415": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "CreatePromotionDTO.rules" + }, + "1416": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "CreatePromotionDTO.campaign" + }, + "1417": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "CreatePromotionDTO.campaign_id" + }, + "1418": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "UpdatePromotionDTO" + }, + "1419": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "UpdatePromotionDTO.id" + }, + "1420": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "UpdatePromotionDTO.is_automatic" + }, + "1421": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "UpdatePromotionDTO.code" + }, + "1422": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "UpdatePromotionDTO.type" + }, + "1423": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "UpdatePromotionDTO.application_method" + }, + "1424": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "UpdatePromotionDTO.campaign_id" + }, + "1425": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "FilterablePromotionProps" + }, + "1426": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "FilterablePromotionProps.id" + }, + "1427": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "FilterablePromotionProps.code" + }, + "1428": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "FilterablePromotionProps.is_automatic" + }, + "1429": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "FilterablePromotionProps.type" + }, + "1430": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion.ts", + "qualifiedName": "FilterablePromotionProps.budget_id" + }, + "1431": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "1432": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "1433": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "PromotionRuleOperatorValues" + }, + "1434": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "PromotionRuleDTO" + }, + "1435": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "PromotionRuleDTO.id" + }, + "1436": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "PromotionRuleDTO.description" + }, + "1437": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "PromotionRuleDTO.attribute" + }, + "1438": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "PromotionRuleDTO.operator" + }, + "1439": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "PromotionRuleDTO.values" + }, + "1440": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "CreatePromotionRuleDTO" + }, + "1441": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "CreatePromotionRuleDTO.description" + }, + "1442": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "CreatePromotionRuleDTO.attribute" + }, + "1443": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "CreatePromotionRuleDTO.operator" + }, + "1444": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "CreatePromotionRuleDTO.values" + }, + "1445": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "UpdatePromotionRuleDTO" + }, + "1446": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "UpdatePromotionRuleDTO.id" + }, + "1447": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "RemovePromotionRuleDTO" + }, + "1448": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "RemovePromotionRuleDTO.id" + }, + "1449": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "FilterablePromotionRuleProps" + }, + "1450": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "FilterablePromotionRuleProps.id" + }, + "1451": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule.ts", + "qualifiedName": "FilterablePromotionRuleProps.code" + }, + "1452": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "1453": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "1454": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", + "qualifiedName": "PromotionRuleValueDTO" + }, + "1455": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", + "qualifiedName": "PromotionRuleValueDTO.id" + }, + "1456": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", + "qualifiedName": "PromotionRuleValueDTO.value" + }, + "1457": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", + "qualifiedName": "CreatePromotionRuleValueDTO" + }, + "1458": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", + "qualifiedName": "CreatePromotionRuleValueDTO.value" + }, + "1459": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", + "qualifiedName": "CreatePromotionRuleValueDTO.promotion_rule" + }, + "1460": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", + "qualifiedName": "UpdatePromotionRuleValueDTO" + }, + "1461": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", + "qualifiedName": "UpdatePromotionRuleValueDTO.id" + }, + "1462": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", + "qualifiedName": "FilterablePromotionRuleValueProps" + }, + "1463": { + "sourceFileName": "../../../packages/types/src/promotion/common/promotion-rule-value.ts", + "qualifiedName": "FilterablePromotionRuleValueProps.id" + }, + "1464": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "1465": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "1466": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignBudgetDTO" + }, + "1467": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignBudgetDTO.type" + }, + "1468": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignBudgetDTO.limit" + }, + "1469": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignBudgetDTO.used" + }, + "1470": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignBudgetDTO" + }, + "1471": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignBudgetDTO.id" + }, + "1472": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignBudgetDTO.type" + }, + "1473": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignBudgetDTO.limit" + }, + "1474": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignBudgetDTO.used" + }, + "1475": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignDTO" + }, + "1476": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignDTO.name" + }, + "1477": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignDTO.description" + }, + "1478": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignDTO.currency" + }, + "1479": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignDTO.campaign_identifier" + }, + "1480": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignDTO.starts_at" + }, + "1481": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignDTO.ends_at" + }, + "1482": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignDTO.budget" + }, + "1483": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "CreateCampaignDTO.promotions" + }, + "1484": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignDTO" + }, + "1485": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignDTO.id" + }, + "1486": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignDTO.name" + }, + "1487": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignDTO.description" + }, + "1488": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignDTO.currency" + }, + "1489": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignDTO.campaign_identifier" + }, + "1490": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignDTO.starts_at" + }, + "1491": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignDTO.ends_at" + }, + "1492": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignDTO.budget" + }, + "1493": { + "sourceFileName": "../../../packages/types/src/promotion/mutations.ts", + "qualifiedName": "UpdateCampaignDTO.promotions" + }, + "1494": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService" + }, + "1495": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.registerUsage" + }, + "1496": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.registerUsage" + }, + "1497": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "computedActions" + }, + "1498": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.computeActions" + }, + "1499": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.computeActions" + }, + "1500": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "promotionCodesToApply" + }, + "1501": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "applicationContext" + }, + "1502": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "options" + }, + "1503": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.create" + }, + "1504": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.create" + }, + "1505": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "data" + }, + "1506": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1507": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.create" + }, + "1508": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "data" + }, + "1509": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1510": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.update" + }, + "1511": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.update" + }, + "1512": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "data" + }, + "1513": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1514": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.update" + }, + "1515": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "data" + }, + "1516": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1517": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.list" + }, + "1518": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.list" + }, + "1519": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "filters" + }, + "1520": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "config" + }, + "1521": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1522": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.retrieve" + }, + "1523": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.retrieve" + }, + "1524": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "id" + }, + "1525": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "config" + }, + "1526": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1527": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.delete" + }, + "1528": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.delete" + }, + "1529": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "ids" + }, + "1530": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1531": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.delete" + }, + "1532": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "ids" + }, + "1533": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1534": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.addPromotionRules" + }, + "1535": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.addPromotionRules" + }, + "1536": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "promotionId" + }, + "1537": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "rulesData" + }, + "1538": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1539": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.addPromotionTargetRules" + }, + "1540": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.addPromotionTargetRules" + }, + "1541": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "promotionId" + }, + "1542": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "rulesData" + }, + "1543": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1544": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.removePromotionRules" + }, + "1545": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.removePromotionRules" + }, + "1546": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "promotionId" + }, + "1547": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "rulesData" + }, + "1548": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1549": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.removePromotionTargetRules" + }, + "1550": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.removePromotionTargetRules" + }, + "1551": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "promotionId" + }, + "1552": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "rulesData" + }, + "1553": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1554": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.createCampaigns" + }, + "1555": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.createCampaigns" + }, + "1556": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "data" + }, + "1557": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1558": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.createCampaigns" + }, + "1559": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "data" + }, + "1560": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1561": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.updateCampaigns" + }, + "1562": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.updateCampaigns" + }, + "1563": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "data" + }, + "1564": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1565": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.updateCampaigns" + }, + "1566": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "data" + }, + "1567": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1568": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.listCampaigns" + }, + "1569": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.listCampaigns" + }, + "1570": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "filters" + }, + "1571": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "config" + }, + "1572": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1573": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.retrieveCampaign" + }, + "1574": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.retrieveCampaign" + }, + "1575": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "id" + }, + "1576": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "config" + }, + "1577": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1578": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.deleteCampaigns" + }, + "1579": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.deleteCampaigns" + }, + "1580": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "ids" + }, + "1581": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1582": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "IPromotionModuleService.deleteCampaigns" + }, + "1583": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "ids" + }, + "1584": { + "sourceFileName": "../../../packages/types/src/promotion/service.ts", + "qualifiedName": "sharedContext" + }, + "1585": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService.__joinerConfig" + }, + "1586": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService.__joinerConfig" + }, + "1587": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService.__hooks" + }, + "1588": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1589": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.onApplicationStart" + }, + "1590": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1591": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "1592": { + "sourceFileName": "../../../packages/types/src/region/index.ts", + "qualifiedName": "" + }, + "1593": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "RegionDTO" + }, + "1594": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type" + }, + "1595": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.name" + }, + "1596": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.currency_code" + }, + "1597": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.tax_rate" + }, + "1598": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.tax_code" + }, + "1599": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.gift_cards_taxable" + }, + "1600": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.automatic_taxes" + }, + "1601": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.tax_provider_id" + }, + "1602": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.metadata" + }, + "1603": { + "sourceFileName": "../../../packages/types/src/region/common.ts", + "qualifiedName": "__type.includes_tax" + }, + "1604": { + "sourceFileName": "../../../packages/types/src/sales-channel/index.ts", + "qualifiedName": "" + }, + "1605": { + "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", + "qualifiedName": "SalesChannelLocationDTO" + }, + "1606": { + "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", + "qualifiedName": "SalesChannelLocationDTO.sales_channel_id" + }, + "1607": { + "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", + "qualifiedName": "SalesChannelLocationDTO.location_id" + }, + "1608": { + "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", + "qualifiedName": "SalesChannelLocationDTO.sales_channel" + }, + "1609": { + "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", + "qualifiedName": "SalesChannelDTO" + }, + "1610": { + "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", + "qualifiedName": "SalesChannelDTO.id" + }, + "1611": { + "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", + "qualifiedName": "SalesChannelDTO.description" + }, + "1612": { + "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", + "qualifiedName": "SalesChannelDTO.is_disabled" + }, + "1613": { + "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", + "qualifiedName": "SalesChannelDTO.metadata" + }, + "1614": { + "sourceFileName": "../../../packages/types/src/sales-channel/common.ts", + "qualifiedName": "SalesChannelDTO.locations" + }, + "1615": { + "sourceFileName": "../../../packages/types/src/search/index.ts", + "qualifiedName": "" + }, + "1616": { + "sourceFileName": "../../../packages/types/src/search/index.ts", + "qualifiedName": "IndexSettings" + }, + "1617": { + "sourceFileName": "../../../packages/types/src/search/index.ts", + "qualifiedName": "__type" + }, + "1618": { + "sourceFileName": "../../../packages/types/src/search/index.ts", + "qualifiedName": "__type.indexSettings" + }, + "1619": { + "sourceFileName": "../../../packages/types/src/search/index.ts", + "qualifiedName": "__type.primaryKey" + }, + "1620": { + "sourceFileName": "../../../packages/types/src/search/index.ts", + "qualifiedName": "__type.transformer" + }, + "1621": { + "sourceFileName": "../../../packages/types/src/search/index.ts", + "qualifiedName": "__type" + }, + "1622": { + "sourceFileName": "../../../packages/types/src/search/index.ts", + "qualifiedName": "__type" + }, + "1623": { + "sourceFileName": "../../../packages/types/src/search/index.ts", + "qualifiedName": "document" + }, + "1624": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService" + }, + "1625": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.options" + }, + "1626": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.createIndex" + }, + "1627": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.createIndex" + }, + "1628": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "indexName" + }, + "1629": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "options" + }, + "1630": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.getIndex" + }, + "1631": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.getIndex" + }, + "1632": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "indexName" + }, + "1633": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.addDocuments" + }, + "1634": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.addDocuments" + }, + "1635": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "indexName" + }, + "1636": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "documents" + }, + "1637": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "type" + }, + "1638": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.replaceDocuments" + }, + "1639": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.replaceDocuments" + }, + "1640": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "indexName" + }, + "1641": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "documents" + }, + "1642": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "type" + }, + "1643": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.deleteDocument" + }, + "1644": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.deleteDocument" + }, + "1645": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "indexName" + }, + "1646": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "document_id" + }, + "1647": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.deleteAllDocuments" + }, + "1648": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.deleteAllDocuments" + }, + "1649": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "indexName" + }, + "1650": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.search" + }, + "1651": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.search" + }, + "1652": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "indexName" + }, + "1653": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "query" + }, + "1654": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "options" + }, + "1655": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.updateSettings" + }, + "1656": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService.updateSettings" + }, + "1657": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "indexName" + }, + "1658": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "settings" + }, + "1659": { + "sourceFileName": "../../../packages/types/src/transaction-base/index.ts", + "qualifiedName": "" + }, + "1660": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "ITransactionBaseService" + }, + "1661": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "ITransactionBaseService.withTransaction" + }, + "1662": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "ITransactionBaseService.withTransaction" + }, + "1663": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "transactionManager" + }, + "1664": { + "sourceFileName": "../../../packages/types/src/workflow/index.ts", + "qualifiedName": "" + }, + "1665": { + "sourceFileName": "../../../packages/types/src/workflow/cart/index.ts", + "qualifiedName": "" + }, + "1666": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateLineItemInputDTO" + }, + "1667": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateLineItemInputDTO.variant_id" + }, + "1668": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateLineItemInputDTO.quantity" + }, + "1669": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateCartWorkflowInputDTO" + }, + "1670": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateCartWorkflowInputDTO.region_id" + }, + "1671": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateCartWorkflowInputDTO.country_code" + }, + "1672": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateCartWorkflowInputDTO.items" + }, + "1673": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateCartWorkflowInputDTO.context" + }, + "1674": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateCartWorkflowInputDTO.sales_channel_id" + }, + "1675": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateCartWorkflowInputDTO.shipping_address_id" + }, + "1676": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateCartWorkflowInputDTO.billing_address_id" + }, + "1677": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateCartWorkflowInputDTO.billing_address" + }, + "1678": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateCartWorkflowInputDTO.shipping_address" + }, + "1679": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateCartWorkflowInputDTO.customer_id" + }, + "1680": { + "sourceFileName": "../../../packages/types/src/workflow/cart/create-cart.ts", + "qualifiedName": "CreateCartWorkflowInputDTO.email" + }, + "1681": { + "sourceFileName": "../../../packages/types/src/workflow/common.ts", + "qualifiedName": "" + }, + "1682": { + "sourceFileName": "../../../packages/types/src/workflow/common.ts", + "qualifiedName": "WorkflowInputConfig" + }, + "1683": { + "sourceFileName": "../../../packages/types/src/workflow/common.ts", + "qualifiedName": "WorkflowInputConfig.listConfig" + }, + "1684": { + "sourceFileName": "../../../packages/types/src/workflow/common.ts", + "qualifiedName": "__type" + }, + "1685": { + "sourceFileName": "../../../packages/types/src/workflow/common.ts", + "qualifiedName": "__type.select" + }, + "1686": { + "sourceFileName": "../../../packages/types/src/workflow/common.ts", + "qualifiedName": "__type.relations" + }, + "1687": { + "sourceFileName": "../../../packages/types/src/workflow/common.ts", + "qualifiedName": "WorkflowInputConfig.retrieveConfig" + }, + "1688": { + "sourceFileName": "../../../packages/types/src/workflow/common.ts", + "qualifiedName": "__type" + }, + "1689": { + "sourceFileName": "../../../packages/types/src/workflow/common.ts", + "qualifiedName": "__type.select" + }, + "1690": { + "sourceFileName": "../../../packages/types/src/workflow/common.ts", + "qualifiedName": "__type.relations" + }, + "1691": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/index.ts", + "qualifiedName": "" + }, + "1692": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListDTO" + }, + "1693": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListDTO.starts_at" + }, + "1694": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListDTO.ends_at" + }, + "1695": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListDTO.status" + }, + "1696": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListDTO.rules_count" + }, + "1697": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListDTO.rules" + }, + "1698": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListDTO.prices" + }, + "1699": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "__type" + }, + "1700": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "__type.amount" + }, + "1701": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "__type.currency_code" + }, + "1702": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "__type.region_id" + }, + "1703": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "__type.max_quantity" + }, + "1704": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "__type.min_quantity" + }, + "1705": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListDTO.customer_groups" + }, + "1706": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "__type" + }, + "1707": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "__type.id" + }, + "1708": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListRuleDTO" + }, + "1709": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListRuleDTO.rule_attribute" + }, + "1710": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListRuleDTO.value" + }, + "1711": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListPriceDTO" + }, + "1712": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListPriceDTO.amount" + }, + "1713": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListPriceDTO.currency_code" + }, + "1714": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListPriceDTO.price_set_id" + }, + "1715": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListPriceDTO.region_id" + }, + "1716": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListPriceDTO.max_quantity" + }, + "1717": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListPriceDTO.min_quantity" + }, + "1718": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowInputDTO" + }, + "1719": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowInputDTO.price_lists" }, "1720": { - "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", - "qualifiedName": "ModuleDeclaration" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "RemovePriceListProductsWorkflowInputDTO" }, "1721": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "InputPrice" + "qualifiedName": "RemovePriceListProductsWorkflowInputDTO.product_ids" }, "1722": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "InputPrice.region_id" + "qualifiedName": "RemovePriceListProductsWorkflowInputDTO.price_list_id" }, "1723": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "InputPrice.currency_code" + "qualifiedName": "RemovePriceListVariantsWorkflowInputDTO" }, "1724": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "InputPrice.amount" + "qualifiedName": "RemovePriceListVariantsWorkflowInputDTO.variant_ids" }, "1725": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "InputPrice.variant_id" + "qualifiedName": "RemovePriceListVariantsWorkflowInputDTO.price_list_id" }, "1726": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "InputPrice.min_quantity" + "qualifiedName": "RemovePriceListPricesWorkflowInputDTO" }, "1727": { "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", - "qualifiedName": "InputPrice.max_quantity" + "qualifiedName": "RemovePriceListPricesWorkflowInputDTO.money_amount_ids" }, "1728": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "Query" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "RemovePriceListPricesWorkflowInputDTO.price_list_id" }, "1729": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "T" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowDTO" }, "1730": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "ExpandScalar" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowDTO.title" }, "1731": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "T" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowDTO.name" }, "1732": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "Scalar" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowDTO.description" }, "1733": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowDTO.type" }, "1734": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.toHexString" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowDTO.starts_at" }, "1735": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.toHexString" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowDTO.ends_at" }, "1736": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "FilterValue" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowDTO.status" }, "1737": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "T" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowDTO.rules_count" }, "1738": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "FilterValue2" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowDTO.prices" }, "1739": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "T" + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "CreatePriceListWorkflowDTO.rules" }, "1740": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "Primary" + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "PriceListVariantPriceDTO" }, "1741": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", "qualifiedName": "__type" }, "1742": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.[PrimaryKeyType]" + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "__type.variant_id" }, "1743": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "__type.price_set_id" }, "1744": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type._id" + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "UpdatePriceListWorkflowDTO" }, "1745": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type" + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "UpdatePriceListWorkflowDTO.id" }, "1746": { - "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.uuid" + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "UpdatePriceListWorkflowDTO.name" }, "1747": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "UpdatePriceListWorkflowDTO.starts_at" + }, + "1748": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "UpdatePriceListWorkflowDTO.ends_at" + }, + "1749": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "UpdatePriceListWorkflowDTO.status" + }, + "1750": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "UpdatePriceListWorkflowDTO.rules" + }, + "1751": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "UpdatePriceListWorkflowDTO.prices" + }, + "1752": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "UpdatePriceListWorkflowDTO.customer_groups" + }, + "1753": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "__type" + }, + "1754": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "__type.id" + }, + "1755": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "UpdatePriceListWorkflowInputDTO" + }, + "1756": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/update-price-list.ts", + "qualifiedName": "UpdatePriceListWorkflowInputDTO.price_lists" + }, + "1757": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/remove-price-list.ts", + "qualifiedName": "RemovePriceListWorkflowInputDTO" + }, + "1758": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/remove-price-list.ts", + "qualifiedName": "RemovePriceListWorkflowInputDTO.price_lists" + }, + "1759": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "FileServiceUploadResult" + }, + "1760": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "__type.url" + }, + "1761": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "__type.key" + }, + "1762": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "FileServiceGetUploadStreamResult" + }, + "1763": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "__type.writeStream" + }, + "1764": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "__type.promise" + }, + "1765": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "__type.url" + }, + "1766": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "__type.fileKey" + }, + "1767": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "GetUploadedFileType" + }, + "1768": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "__type.fileKey" + }, + "1769": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "__type.isPrivate" + }, + "1770": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "DeleteFileType" + }, + "1771": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "__type.fileKey" + }, + "1772": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "UploadStreamDescriptorType" + }, + "1773": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "__type.name" + }, + "1774": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "__type.ext" + }, + "1775": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "__type.isPrivate" + }, + "1776": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerRelationship" + }, + "1777": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type" + }, + "1778": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.alias" + }, + "1779": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.foreignKey" + }, + "1780": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.primaryKey" + }, + "1781": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.serviceName" + }, + "1782": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.isInternalService" + }, + "1783": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.inverse" + }, + "1784": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.isList" + }, + "1785": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.args" + }, + "1786": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerServiceConfigAlias" + }, + "1787": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerServiceConfigAlias.name" + }, + "1788": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerServiceConfigAlias.args" + }, + "1789": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerServiceConfig" + }, + "1790": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerServiceConfig.serviceName" + }, + "1791": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerServiceConfig.alias" + }, + "1792": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerServiceConfig.fieldAlias" + }, + "1793": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type" + }, + "1794": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.path" + }, + "1795": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.forwardArgumentsOnPath" + }, + "1796": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerServiceConfig.primaryKeys" + }, + "1797": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerServiceConfig.relationships" + }, + "1798": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerServiceConfig.extends" + }, + "1799": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type" + }, + "1800": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.serviceName" + }, + "1801": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.relationship" + }, + "1802": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerServiceConfig.args" + }, + "1803": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerArgument" + }, + "1804": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerArgument.name" + }, + "1805": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerArgument.value" + }, + "1806": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerDirective" + }, + "1807": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerDirective.name" + }, + "1808": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "JoinerDirective.value" + }, + "1809": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteJoinerQuery" + }, + "1810": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteJoinerQuery.service" + }, + "1811": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteJoinerQuery.alias" + }, + "1812": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteJoinerQuery.expands" + }, + "1813": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type" + }, + "1814": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.property" + }, + "1815": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.fields" + }, + "1816": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.args" + }, + "1817": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.directives" + }, + "1818": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type" + }, + "1819": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.__index" + }, + "1821": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteJoinerQuery.fields" + }, + "1822": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteJoinerQuery.args" + }, + "1823": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteJoinerQuery.directives" + }, + "1824": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type" + }, + "1825": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.__index" + }, + "1827": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteNestedExpands" + }, + "1828": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteNestedExpands.__index" + }, + "1830": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type" + }, + "1831": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.fields" + }, + "1832": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.args" + }, + "1833": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "__type.expands" + }, + "1834": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteExpandProperty" + }, + "1835": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteExpandProperty.property" + }, + "1836": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteExpandProperty.parent" + }, + "1837": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteExpandProperty.parentConfig" + }, + "1838": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteExpandProperty.serviceConfig" + }, + "1839": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteExpandProperty.fields" + }, + "1840": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteExpandProperty.args" + }, + "1841": { + "sourceFileName": "../../../packages/types/src/joiner/index.ts", + "qualifiedName": "RemoteExpandProperty.expands" + }, + "1842": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule" + }, + "1843": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.__joinerConfig" + }, + "1844": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.__joinerConfig" + }, + "1845": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.list" + }, + "1846": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.list" + }, + "1847": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "filters" + }, + "1848": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "config" + }, + "1849": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "sharedContext" + }, + "1850": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.listAndCount" + }, + "1851": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.listAndCount" + }, + "1852": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "filters" + }, + "1853": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "config" + }, + "1854": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "sharedContext" + }, + "1855": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.create" + }, + "1856": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.create" + }, + "1857": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "primaryKeyOrBulkData" + }, + "1858": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "foreignKeyData" + }, + "1859": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "sharedContext" + }, + "1860": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.dismiss" + }, + "1861": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.dismiss" + }, + "1862": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "primaryKeyOrBulkData" + }, + "1863": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "foreignKeyData" + }, + "1864": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "sharedContext" + }, + "1865": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.delete" + }, + "1866": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.delete" + }, + "1867": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "data" + }, + "1868": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "sharedContext" + }, + "1869": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.softDelete" + }, + "1870": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.softDelete" + }, + "1871": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "data" + }, + "1872": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "config" + }, + "1873": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "sharedContext" + }, + "1874": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.restore" + }, + "1875": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "ILinkModule.restore" + }, + "1876": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "data" + }, + "1877": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "config" + }, + "1878": { + "sourceFileName": "../../../packages/types/src/link-modules/index.ts", + "qualifiedName": "sharedContext" + }, + "1879": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "CurrencyDTO" + }, + "1880": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "CurrencyDTO.code" + }, + "1881": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "CurrencyDTO.symbol" + }, + "1882": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "CurrencyDTO.symbol_native" + }, + "1883": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "CurrencyDTO.name" + }, + "1884": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "CreateCurrencyDTO" + }, + "1885": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "CreateCurrencyDTO.code" + }, + "1886": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "CreateCurrencyDTO.symbol" + }, + "1887": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "CreateCurrencyDTO.symbol_native" + }, + "1888": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "CreateCurrencyDTO.name" + }, + "1889": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "UpdateCurrencyDTO" + }, + "1890": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "UpdateCurrencyDTO.code" + }, + "1891": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "UpdateCurrencyDTO.symbol" + }, + "1892": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "UpdateCurrencyDTO.symbol_native" + }, + "1893": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "UpdateCurrencyDTO.name" + }, + "1894": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "FilterableCurrencyProps" + }, + "1895": { + "sourceFileName": "../../../packages/types/src/pricing/common/currency.ts", + "qualifiedName": "FilterableCurrencyProps.code" + }, + "1896": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "1897": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "1898": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "MoneyAmountDTO" + }, + "1899": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "MoneyAmountDTO.id" + }, + "1900": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "MoneyAmountDTO.currency_code" + }, + "1901": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "MoneyAmountDTO.currency" + }, + "1902": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "MoneyAmountDTO.amount" + }, + "1903": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "MoneyAmountDTO.min_quantity" + }, + "1904": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "MoneyAmountDTO.max_quantity" + }, + "1905": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "MoneyAmountDTO.price_set_money_amount" + }, + "1906": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "MoneyAmountDTO.created_at" + }, + "1907": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "MoneyAmountDTO.updated_at" + }, + "1908": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "MoneyAmountDTO.deleted_at" + }, + "1909": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO" + }, + "1910": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.id" + }, + "1911": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.currency_code" + }, + "1912": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.currency" + }, + "1913": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.amount" + }, + "1914": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.min_quantity" + }, + "1915": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.max_quantity" + }, + "1916": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "UpdateMoneyAmountDTO" + }, + "1917": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "UpdateMoneyAmountDTO.id" + }, + "1918": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "UpdateMoneyAmountDTO.currency_code" + }, + "1919": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "UpdateMoneyAmountDTO.amount" + }, + "1920": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "UpdateMoneyAmountDTO.min_quantity" + }, + "1921": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "UpdateMoneyAmountDTO.max_quantity" + }, + "1922": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "FilterableMoneyAmountProps" + }, + "1923": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "FilterableMoneyAmountProps.id" + }, + "1924": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "FilterableMoneyAmountProps.currency_code" + }, + "1925": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "1926": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "1927": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO" + }, + "1928": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO.id" + }, + "1929": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO.price_set_id" + }, + "1930": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO.price_set" + }, + "1931": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO.rule_type_id" + }, + "1932": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO.rule_type" + }, + "1933": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO.value" + }, + "1934": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO.priority" + }, + "1935": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO.price_set_money_amount_id" + }, + "1936": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO.price_list_id" + }, + "1937": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO.created_at" + }, + "1938": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO.updated_at" + }, + "1939": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "PriceRuleDTO.deleted_at" + }, + "1940": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "CreatePriceRuleDTO" + }, + "1941": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "CreatePriceRuleDTO.price_set_id" + }, + "1942": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "CreatePriceRuleDTO.price_set" + }, + "1943": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "CreatePriceRuleDTO.rule_type_id" + }, + "1944": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "CreatePriceRuleDTO.rule_type" + }, + "1945": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "CreatePriceRuleDTO.value" + }, + "1946": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "CreatePriceRuleDTO.priority" + }, + "1947": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "CreatePriceRuleDTO.price_set_money_amount_id" + }, + "1948": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "CreatePriceRuleDTO.price_set_money_amount" + }, + "1949": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "UpdatePriceRuleDTO" + }, + "1950": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "UpdatePriceRuleDTO.id" + }, + "1951": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "UpdatePriceRuleDTO.price_set_id" + }, + "1952": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "UpdatePriceRuleDTO.rule_type_id" + }, + "1953": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "UpdatePriceRuleDTO.value" + }, + "1954": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "UpdatePriceRuleDTO.priority" + }, + "1955": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "UpdatePriceRuleDTO.price_set_money_amount_id" + }, + "1956": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "UpdatePriceRuleDTO.price_list_id" + }, + "1957": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "FilterablePriceRuleProps" + }, + "1958": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "FilterablePriceRuleProps.id" + }, + "1959": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "FilterablePriceRuleProps.name" + }, + "1960": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "FilterablePriceRuleProps.price_set_id" + }, + "1961": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-rule.ts", + "qualifiedName": "FilterablePriceRuleProps.rule_type_id" + }, + "1962": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "1963": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "1964": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "PricingRepositoryService" + }, + "1965": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "PricingRepositoryService.calculatePrices" + }, + "1966": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "PricingRepositoryService.calculatePrices" + }, + "1967": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "pricingFilters" + }, + "1968": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "pricingContext" + }, + "1969": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "context" + }, + "1970": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "PricingContext" + }, + "1971": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "PricingContext.context" + }, + "1972": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "PricingFilters" + }, + "1973": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "PricingFilters.id" + }, + "1974": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "PriceSetDTO" + }, + "1975": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "PriceSetDTO.id" + }, + "1976": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "PriceSetDTO.money_amounts" + }, + "1977": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "PriceSetDTO.rule_types" + }, + "1978": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSetDTO" + }, + "1979": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSetDTO.id" + }, + "1980": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSetDTO.price_set_id" + }, + "1981": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSetDTO.amount" + }, + "1982": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSetDTO.currency_code" + }, + "1983": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSetDTO.min_quantity" + }, + "1984": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSetDTO.max_quantity" + }, + "1985": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSetDTO.price_list_type" + }, + "1986": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSetDTO.price_list_id" + }, + "1987": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSet" + }, + "1988": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSet.id" + }, + "1989": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSet.is_calculated_price_price_list" + }, + "1990": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSet.calculated_amount" + }, + "1991": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSet.is_original_price_price_list" + }, + "1992": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSet.original_amount" + }, + "1993": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSet.currency_code" + }, + "1994": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSet.calculated_price" + }, + "1995": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type" + }, + "1996": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type.money_amount_id" + }, + "1997": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type.price_list_id" + }, + "1998": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type.price_list_type" + }, + "1999": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type.min_quantity" + }, + "2000": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type.max_quantity" + }, + "2001": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CalculatedPriceSet.original_price" + }, + "2002": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type" + }, + "2003": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type.money_amount_id" + }, + "2004": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type.price_list_id" + }, + "2005": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type.price_list_type" + }, + "2006": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type.min_quantity" + }, + "2007": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type.max_quantity" + }, + "2008": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "AddRulesDTO" + }, + "2009": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "AddRulesDTO.priceSetId" + }, + "2010": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "AddRulesDTO.rules" + }, + "2011": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type" + }, + "2012": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type.attribute" + }, + "2013": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CreatePricesDTO" + }, + "2014": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CreatePricesDTO.rules" + }, + "2015": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.id" + }, + "2016": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.currency_code" + }, + "2017": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.currency" + }, + "2018": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.amount" + }, + "2019": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.min_quantity" + }, + "2020": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.max_quantity" + }, + "2021": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "AddPricesDTO" + }, + "2022": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "AddPricesDTO.priceSetId" + }, + "2023": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "AddPricesDTO.prices" + }, + "2024": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "RemovePriceSetRulesDTO" + }, + "2025": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "RemovePriceSetRulesDTO.id" + }, + "2026": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "RemovePriceSetRulesDTO.rules" + }, + "2027": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CreatePriceSetDTO" + }, + "2028": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CreatePriceSetDTO.rules" + }, + "2029": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type" + }, + "2030": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "__type.rule_attribute" + }, + "2031": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "CreatePriceSetDTO.prices" + }, + "2032": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "UpdatePriceSetDTO" + }, + "2033": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "UpdatePriceSetDTO.id" + }, + "2034": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "FilterablePriceSetProps" + }, + "2035": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "FilterablePriceSetProps.id" + }, + "2036": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set.ts", + "qualifiedName": "FilterablePriceSetProps.money_amounts" + }, + "2037": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "2038": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "2039": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "PriceSetMoneyAmountDTO" + }, + "2040": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "PriceSetMoneyAmountDTO.id" + }, + "2041": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "PriceSetMoneyAmountDTO.title" + }, + "2042": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "PriceSetMoneyAmountDTO.price_set" + }, + "2043": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "PriceSetMoneyAmountDTO.price_list" + }, + "2044": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "PriceSetMoneyAmountDTO.price_set_id" + }, + "2045": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "PriceSetMoneyAmountDTO.price_rules" + }, + "2046": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "PriceSetMoneyAmountDTO.money_amount" + }, + "2047": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "PriceSetMoneyAmountDTO.created_at" + }, + "2048": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "PriceSetMoneyAmountDTO.updated_at" + }, + "2049": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "PriceSetMoneyAmountDTO.deleted_at" + }, + "2050": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "UpdatePriceSetMoneyAmountDTO" + }, + "2051": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "UpdatePriceSetMoneyAmountDTO.id" + }, + "2052": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "UpdatePriceSetMoneyAmountDTO.title" + }, + "2053": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "UpdatePriceSetMoneyAmountDTO.price_set" + }, + "2054": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "UpdatePriceSetMoneyAmountDTO.money_amount" + }, + "2055": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "CreatePriceSetMoneyAmountDTO" + }, + "2056": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "CreatePriceSetMoneyAmountDTO.title" + }, + "2057": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "CreatePriceSetMoneyAmountDTO.price_set" + }, + "2058": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "CreatePriceSetMoneyAmountDTO.price_list" + }, + "2059": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "CreatePriceSetMoneyAmountDTO.money_amount" + }, + "2060": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "CreatePriceSetMoneyAmountDTO.rules_count" + }, + "2061": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "FilterablePriceSetMoneyAmountProps" + }, + "2062": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "FilterablePriceSetMoneyAmountProps.id" + }, + "2063": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "FilterablePriceSetMoneyAmountProps.price_set_id" + }, + "2064": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount.ts", + "qualifiedName": "FilterablePriceSetMoneyAmountProps.price_list_id" + }, + "2065": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "2066": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "2067": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "PriceSetMoneyAmountRulesDTO" + }, + "2068": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "PriceSetMoneyAmountRulesDTO.id" + }, + "2069": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "PriceSetMoneyAmountRulesDTO.price_set_money_amount" + }, + "2070": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "PriceSetMoneyAmountRulesDTO.rule_type" + }, + "2071": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "PriceSetMoneyAmountRulesDTO.value" + }, + "2072": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "CreatePriceSetMoneyAmountRulesDTO" + }, + "2073": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "CreatePriceSetMoneyAmountRulesDTO.price_set_money_amount" + }, + "2074": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "CreatePriceSetMoneyAmountRulesDTO.rule_type" + }, + "2075": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "CreatePriceSetMoneyAmountRulesDTO.value" + }, + "2076": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO" + }, + "2077": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO.id" + }, + "2078": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO.price_set_money_amount" + }, + "2079": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO.rule_type" + }, + "2080": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "UpdatePriceSetMoneyAmountRulesDTO.value" + }, + "2081": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps" + }, + "2082": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps.id" + }, + "2083": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps.rule_type_id" + }, + "2084": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps.price_set_money_amount_id" + }, + "2085": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-money-amount-rules.ts", + "qualifiedName": "FilterablePriceSetMoneyAmountRulesProps.value" + }, + "2086": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "2087": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "2088": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "PriceSetRuleTypeDTO" + }, + "2089": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "PriceSetRuleTypeDTO.id" + }, + "2090": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "PriceSetRuleTypeDTO.price_set" + }, + "2091": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "PriceSetRuleTypeDTO.rule_type" + }, + "2092": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "PriceSetRuleTypeDTO.value" + }, + "2093": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "CreatePriceSetRuleTypeDTO" + }, + "2094": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "CreatePriceSetRuleTypeDTO.price_set" + }, + "2095": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "CreatePriceSetRuleTypeDTO.rule_type" + }, + "2096": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "UpdatePriceSetRuleTypeDTO" + }, + "2097": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "UpdatePriceSetRuleTypeDTO.id" + }, + "2098": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "UpdatePriceSetRuleTypeDTO.price_set" + }, + "2099": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "UpdatePriceSetRuleTypeDTO.rule_type" + }, + "2100": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "FilterablePriceSetRuleTypeProps" + }, + "2101": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "FilterablePriceSetRuleTypeProps.id" + }, + "2102": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "FilterablePriceSetRuleTypeProps.rule_type_id" + }, + "2103": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-set-rule-type.ts", + "qualifiedName": "FilterablePriceSetRuleTypeProps.price_set_id" + }, + "2104": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "2105": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "2106": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "RuleTypeDTO" + }, + "2107": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "RuleTypeDTO.id" + }, + "2108": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "RuleTypeDTO.name" + }, + "2109": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "RuleTypeDTO.rule_attribute" + }, + "2110": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "RuleTypeDTO.default_priority" + }, + "2111": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "CreateRuleTypeDTO" + }, + "2112": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "CreateRuleTypeDTO.id" + }, + "2113": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "CreateRuleTypeDTO.name" + }, + "2114": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "CreateRuleTypeDTO.rule_attribute" + }, + "2115": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "CreateRuleTypeDTO.default_priority" + }, + "2116": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "UpdateRuleTypeDTO" + }, + "2117": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "UpdateRuleTypeDTO.id" + }, + "2118": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "UpdateRuleTypeDTO.name" + }, + "2119": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "UpdateRuleTypeDTO.rule_attribute" + }, + "2120": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "UpdateRuleTypeDTO.default_priority" + }, + "2121": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "FilterableRuleTypeProps" + }, + "2122": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "FilterableRuleTypeProps.id" + }, + "2123": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "FilterableRuleTypeProps.name" + }, + "2124": { + "sourceFileName": "../../../packages/types/src/pricing/common/rule-type.ts", + "qualifiedName": "FilterableRuleTypeProps.rule_attribute" + }, + "2125": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "2126": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "2127": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListStatus" + }, + "2128": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListStatus.ACTIVE" + }, + "2129": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListStatus.DRAFT" + }, + "2130": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListType" + }, + "2131": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListType.SALE" + }, + "2132": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListType.OVERRIDE" + }, + "2133": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListDTO" + }, + "2134": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListDTO.id" + }, + "2135": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListDTO.title" + }, + "2136": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListDTO.starts_at" + }, + "2137": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListDTO.status" + }, + "2138": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListDTO.ends_at" + }, + "2139": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListDTO.rules_count" + }, + "2140": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListDTO.price_set_money_amounts" + }, + "2141": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListDTO.money_amounts" + }, + "2142": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListDTO.rule_types" + }, + "2143": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListDTO.rules" + }, + "2144": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListDTO.price_list_rules" + }, + "2145": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListPriceDTO" + }, + "2146": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListPriceDTO.price_set_id" + }, + "2147": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListPriceDTO.rules" + }, + "2148": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.id" + }, + "2149": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.currency_code" + }, + "2150": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.currency" + }, + "2151": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.amount" + }, + "2152": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.min_quantity" + }, + "2153": { + "sourceFileName": "../../../packages/types/src/pricing/common/money-amount.ts", + "qualifiedName": "CreateMoneyAmountDTO.max_quantity" + }, + "2154": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceSetPriceRules" + }, + "2155": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListRules" + }, + "2156": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListDTO" + }, + "2157": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListDTO.title" + }, + "2158": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListDTO.description" + }, + "2159": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListDTO.starts_at" + }, + "2160": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListDTO.ends_at" + }, + "2161": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListDTO.status" + }, + "2162": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListDTO.type" + }, + "2163": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListDTO.rules_count" + }, + "2164": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListDTO.rules" + }, + "2165": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListDTO.prices" + }, + "2166": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListDTO" + }, + "2167": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListDTO.id" + }, + "2168": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListDTO.title" + }, + "2169": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListDTO.description" + }, + "2170": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListDTO.starts_at" + }, + "2171": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListDTO.ends_at" + }, + "2172": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListDTO.status" + }, + "2173": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListDTO.rules_count" + }, + "2174": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListDTO.rules" + }, + "2175": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListProps" + }, + "2176": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListProps.id" + }, + "2177": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListProps.starts_at" + }, + "2178": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListProps.ends_at" + }, + "2179": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListProps.status" + }, + "2180": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListProps.rules_count" + }, + "2181": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "2182": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "2183": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListRuleProps" + }, + "2184": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListRuleProps.id" + }, + "2185": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListRuleProps.value" + }, + "2186": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListRuleProps.rule_type" + }, + "2187": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListRuleProps.price_list_id" + }, + "2188": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "2189": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "2190": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListRuleValueProps" + }, + "2191": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListRuleValueProps.id" + }, + "2192": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListRuleValueProps.value" + }, + "2193": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "FilterablePriceListRuleValueProps.price_list_rule_id" + }, + "2194": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$and" + }, + "2195": { + "sourceFileName": "../../../packages/types/src/dal/index.ts", + "qualifiedName": "BaseFilterable.$or" + }, + "2196": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListRuleDTO" + }, + "2197": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListRuleDTO.id" + }, + "2198": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListRuleDTO.value" + }, + "2199": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListRuleDTO.rule_type" + }, + "2200": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListRuleDTO.price_list" + }, + "2201": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListRuleDTO.price_list_rule_values" + }, + "2202": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListRuleDTO" + }, + "2203": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListRuleDTO.rule_type_id" + }, + "2204": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListRuleDTO.rule_type" + }, + "2205": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListRuleDTO.price_list_id" + }, + "2206": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListRuleDTO.price_list" + }, + "2207": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListRuleDTO" + }, + "2208": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListRuleDTO.id" + }, + "2209": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListRuleDTO.price_list_id" + }, + "2210": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListRuleDTO.rule_type_id" + }, + "2211": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListRuleDTO.price_list" + }, + "2212": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListRuleDTO.rule_type" + }, + "2213": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListRuleValueDTO" + }, + "2214": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListRuleValueDTO.id" + }, + "2215": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListRuleValueDTO.value" + }, + "2216": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "PriceListRuleValueDTO.price_list_rule" + }, + "2217": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListRuleValueDTO" + }, + "2218": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListRuleValueDTO.value" + }, + "2219": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListRuleValueDTO.price_list_rule_id" + }, + "2220": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "CreatePriceListRuleValueDTO.price_list_rule" + }, + "2221": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListRuleValueDTO" + }, + "2222": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListRuleValueDTO.id" + }, + "2223": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListRuleValueDTO.value" + }, + "2224": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "UpdatePriceListRuleValueDTO.price_list_rule_id" + }, + "2225": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "AddPriceListPricesDTO" + }, + "2226": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "AddPriceListPricesDTO.priceListId" + }, + "2227": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "AddPriceListPricesDTO.prices" + }, + "2228": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "SetPriceListRulesDTO" + }, + "2229": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "SetPriceListRulesDTO.priceListId" + }, + "2230": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "SetPriceListRulesDTO.rules" + }, + "2231": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "RemovePriceListRulesDTO" + }, + "2232": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "RemovePriceListRulesDTO.priceListId" + }, + "2233": { + "sourceFileName": "../../../packages/types/src/pricing/common/price-list.ts", + "qualifiedName": "RemovePriceListRulesDTO.rules" + }, + "2234": { + "sourceFileName": "../../../packages/types/src/payment/service.ts", + "qualifiedName": "IPaymentModuleService" + }, + "2235": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService.__joinerConfig" + }, + "2236": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService.__joinerConfig" + }, + "2237": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "IModuleService.__hooks" + }, + "2238": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "2239": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type.onApplicationStart" + }, + "2240": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "2241": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "__type" + }, + "2242": { + "sourceFileName": "../../../packages/types/src/product-category/repository.ts", + "qualifiedName": "ProductCategoryTransformOptions" + }, + "2243": { + "sourceFileName": "../../../packages/types/src/product-category/repository.ts", + "qualifiedName": "ProductCategoryTransformOptions.includeDescendantsTree" + }, + "2244": { + "sourceFileName": "../../../packages/types/src/shared-context.ts", + "qualifiedName": "SharedContext" + }, + "2245": { + "sourceFileName": "../../../packages/types/src/shared-context.ts", + "qualifiedName": "__type.transactionManager" + }, + "2246": { + "sourceFileName": "../../../packages/types/src/shared-context.ts", + "qualifiedName": "__type.manager" + }, + "2247": { + "sourceFileName": "../../../packages/types/src/shared-context.ts", + "qualifiedName": "Context" + }, + "2248": { + "sourceFileName": "../../../packages/types/src/shared-context.ts", + "qualifiedName": "__type.transactionManager" + }, + "2249": { + "sourceFileName": "../../../packages/types/src/shared-context.ts", + "qualifiedName": "__type.manager" + }, + "2250": { + "sourceFileName": "../../../packages/types/src/shared-context.ts", + "qualifiedName": "__type.isolationLevel" + }, + "2251": { + "sourceFileName": "../../../packages/types/src/shared-context.ts", + "qualifiedName": "__type.enableNestedTransactions" + }, + "2252": { + "sourceFileName": "../../../packages/types/src/shared-context.ts", + "qualifiedName": "__type.transactionId" + }, + "2253": { + "sourceFileName": "../../../packages/types/src/shared-context.ts", + "qualifiedName": "TManager" + }, + "2254": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "OperatorMap" + }, + "2255": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "__type" }, - "1748": { + "2256": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", - "qualifiedName": "__type.id" + "qualifiedName": "__type.$and" }, - "1749": { + "2257": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$or" + }, + "2258": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$eq" + }, + "2259": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$ne" + }, + "2260": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$in" + }, + "2261": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$nin" + }, + "2262": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$not" + }, + "2263": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$gt" + }, + "2264": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$gte" + }, + "2265": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$lt" + }, + "2266": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$lte" + }, + "2267": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$like" + }, + "2268": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$re" + }, + "2269": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$ilike" + }, + "2270": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$fulltext" + }, + "2271": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$overlap" + }, + "2272": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$contains" + }, + "2273": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$contained" + }, + "2274": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.$exists" + }, + "2275": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "T" }, - "1750": { + "2276": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "SessionOptions" + }, + "2277": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.name" + }, + "2278": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.resave" + }, + "2279": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.rolling" + }, + "2280": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.saveUninitialized" + }, + "2281": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.secret" + }, + "2282": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.ttl" + }, + "2283": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "PrevLimit" + }, + "2284": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "Order" + }, + "2285": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "T" + }, + "2286": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "Dictionary" + }, + "2287": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type" + }, + "2288": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.__index" + }, + "2290": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "T" + }, + "2291": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService" + }, + "2292": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.transaction" + }, + "2293": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.transaction" + }, + "2294": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TManager" + }, + "2295": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "task" + }, + "2296": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type" + }, + "2297": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type" + }, + "2298": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "transactionManager" + }, + "2299": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "context" + }, + "2300": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type" + }, + "2301": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type.isolationLevel" + }, + "2302": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type.transaction" + }, + "2303": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "__type.enableNestedTransactions" + }, + "2304": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.getFreshManager" + }, + "2305": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.getFreshManager" + }, + "2306": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TManager" + }, + "2307": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.getActiveManager" + }, + "2308": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.getActiveManager" + }, + "2309": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TManager" + }, + "2310": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.serialize" + }, + "2311": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.serialize" + }, + "2312": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "TOutput" + }, + "2313": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "data" + }, + "2314": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "options" + }, + "2315": { + "sourceFileName": "../../../packages/types/src/dal/repository-service.ts", + "qualifiedName": "BaseRepositoryService.T" + }, + "2316": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ModuleDeclaration" + }, + "2317": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "InputPrice" + }, + "2318": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "InputPrice.region_id" + }, + "2319": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "InputPrice.currency_code" + }, + "2320": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "InputPrice.amount" + }, + "2321": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "InputPrice.variant_id" + }, + "2322": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "InputPrice.min_quantity" + }, + "2323": { + "sourceFileName": "../../../packages/types/src/workflow/price-list/create-price-list.ts", + "qualifiedName": "InputPrice.max_quantity" + }, + "2324": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "Query" + }, + "2325": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "T" + }, + "2326": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "ExpandScalar" + }, + "2327": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "T" + }, + "2328": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "Scalar" + }, + "2329": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type" + }, + "2330": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.toHexString" + }, + "2331": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.toHexString" + }, + "2332": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "FilterValue" + }, + "2333": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "T" + }, + "2334": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "FilterValue2" + }, + "2335": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "T" + }, + "2336": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "Primary" + }, + "2337": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type" + }, + "2338": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.[PrimaryKeyType]" + }, + "2339": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type" + }, + "2340": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type._id" + }, + "2341": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type" + }, + "2342": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.uuid" + }, + "2343": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type" + }, + "2344": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "__type.id" + }, + "2345": { + "sourceFileName": "../../../packages/types/src/dal/utils.ts", + "qualifiedName": "T" + }, + "2346": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "ReadonlyPrimary" }, - "1751": { + "2347": { "sourceFileName": "../../../packages/types/src/dal/utils.ts", "qualifiedName": "T" } diff --git a/docs-util/typedoc-json-output/file.json b/docs-util/typedoc-json-output/file.json new file mode 100644 index 0000000000..99170e7f95 --- /dev/null +++ b/docs-util/typedoc-json-output/file.json @@ -0,0 +1,2855 @@ +{ + "id": 0, + "name": "file", + "variant": "project", + "kind": 1, + "flags": {}, + "children": [ + { + "id": 1, + "name": "IFileService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\nA file service class is defined in a TypeScript or JavaScript file that’s created in the " + }, + { + "kind": "code", + "text": "`src/services`" + }, + { + "kind": "text", + "text": " directory.\nThe class must extend the " + }, + { + "kind": "code", + "text": "`AbstractFileService`" + }, + { + "kind": "text", + "text": " class imported from the " + }, + { + "kind": "code", + "text": "`@medusajs/medusa`" + }, + { + "kind": "text", + "text": " package.\n\nBased on services’ naming conventions, the file’s name should be the slug version of the file service’s name\nwithout " + }, + { + "kind": "code", + "text": "`service`" + }, + { + "kind": "text", + "text": ", and the class’s name should be the pascal case of the file service’s name following by " + }, + { + "kind": "code", + "text": "`Service`" + }, + { + "kind": "text", + "text": ".\n\nFor example, create the file " + }, + { + "kind": "code", + "text": "`src/services/local-file.ts`" + }, + { + "kind": "text", + "text": " with the following content:\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/services/local-file.ts\"\nimport { AbstractFileService } from \"@medusajs/medusa\"\nimport {\n DeleteFileType,\n FileServiceGetUploadStreamResult,\n FileServiceUploadResult,\n GetUploadedFileType,\n UploadStreamDescriptorType,\n} from \"@medusajs/types\"\n\nclass LocalFileService extends AbstractFileService {\n async upload(\n fileData: Express.Multer.File\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n async uploadProtected(\n fileData: Express.Multer.File\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n async delete(fileData: DeleteFileType): Promise {\n throw new Error(\"Method not implemented.\")\n }\n async getUploadStreamDescriptor(\n fileData: UploadStreamDescriptorType\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n async getDownloadStream(\n fileData: GetUploadedFileType\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n async getPresignedDownloadUrl(\n fileData: GetUploadedFileType\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n}\n\nexport default LocalFileService\n```" + }, + { + "kind": "text", + "text": "\n\n:::note[Multer Typing]\n\nThe examples implement a file service supporting local uploads.\n\nIf you’re using TypeScript and you're following along with the implementation,\nyou should install the Multer types package in the root of your Medusa backend to resolve errors within your file service types:\n\n" + }, + { + "kind": "code", + "text": "```bash npm2yarn\nnpm install @types/multer\n```" + }, + { + "kind": "text", + "text": "\n\n:::\n\n---" + } + ] + }, + "children": [ + { + "id": 2, + "name": "upload", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3, + "name": "upload", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to upload a file to the Medusa backend." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the upload's result." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n // ...\n async upload(\n fileData: Express.Multer.File\n ): Promise {\n const filePath =\n `${this.publicPath}/${fileData.originalname}`\n fs.copyFileSync(fileData.path, filePath)\n return {\n url: `${this.serverUrl}/${filePath}`,\n key: filePath,\n }\n }\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::tip\n\nThis example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name.\n\n:::" + } + ] + } + ] + }, + "parameters": [ + { + "id": 4, + "name": "file", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A [multer file object](http://expressjs.com/en/resources/middleware/multer.html#file-information).\nThe file is uploaded to a temporary directory by default. Among the file’s details, you can access the file’s path in the " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": " property of the file object." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/multer/index.d.ts", + "qualifiedName": "__global.Express.Multer.File" + }, + "name": "File", + "package": "@types/multer", + "qualifiedName": "__global.Express.Multer.File" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "FileServiceUploadResult" + }, + "name": "FileServiceUploadResult", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 5, + "name": "uploadProtected", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 6, + "name": "uploadProtected", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to upload a file to the Medusa backend, but to a protected storage. Typically, this would be used to store files that\nshouldn’t be accessible by using the file’s URL or should only be accessible by authenticated users. For example, exported or imported\nCSV files." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the upload's result." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n // ...\n async uploadProtected(\n fileData: Express.Multer.File\n ): Promise {\n const filePath =\n `${this.protectedPath}/${fileData.originalname}`\n fs.copyFileSync(fileData.path, filePath)\n return {\n url: `${this.serverUrl}/${filePath}`,\n key: filePath\n }\n }\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::tip\n\nThis example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name.\n\n:::" + } + ] + } + ] + }, + "parameters": [ + { + "id": 7, + "name": "file", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A [multer file object](http://expressjs.com/en/resources/middleware/multer.html#file-information).\nThe file is uploaded to a temporary directory by default. Among the file’s details, you can access the file’s path in the " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": " property of the file object." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/multer/index.d.ts", + "qualifiedName": "__global.Express.Multer.File" + }, + "name": "File", + "package": "@types/multer", + "qualifiedName": "__global.Express.Multer.File" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "FileServiceUploadResult" + }, + "name": "FileServiceUploadResult", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 8, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 9, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to delete a file from storage." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Resolves when the file is deleted successfully." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n\n async delete(\n fileData: DeleteFileType\n ): Promise {\n fs.rmSync(fileData.fileKey)\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 10, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to remove." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "DeleteFileType" + }, + "name": "DeleteFileType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 11, + "name": "getUploadStreamDescriptor", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 12, + "name": "getUploadStreamDescriptor", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a write stream to be used to upload a file." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The result of the file-stream upload." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport { Stream } from \"stream\"\n\nclass LocalFileService extends AbstractFileService {\n // ...\n async getUploadStreamDescriptor({\n name,\n ext,\n isPrivate = true,\n }: UploadStreamDescriptorType\n ): Promise {\n const filePath = `${isPrivate ?\n this.publicPath : this.protectedPath\n }/${name}.${ext}`\n\n const pass = new Stream.PassThrough()\n const writeStream = fs.createWriteStream(filePath)\n\n pass.pipe(writeStream)\n\n return {\n writeStream: pass,\n promise: Promise.resolve(),\n url: `${this.serverUrl}/${filePath}`,\n fileKey: filePath,\n }\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 13, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file being uploaded." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "UploadStreamDescriptorType" + }, + "name": "UploadStreamDescriptorType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "FileServiceGetUploadStreamResult" + }, + "name": "FileServiceGetUploadStreamResult", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 14, + "name": "getDownloadStream", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 15, + "name": "getDownloadStream", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a read stream for a file, which can then be used to download the file." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The [read stream](https://nodejs.org/api/webstreams.html#class-readablestream) to read and download the file." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n\n async getDownloadStream({\n fileKey,\n isPrivate = true,\n }: GetUploadedFileType\n ): Promise {\n const filePath = `${isPrivate ?\n this.publicPath : this.protectedPath\n }/${fileKey}`\n const readStream = fs.createReadStream(filePath)\n\n return readStream\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 16, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "GetUploadedFileType" + }, + "name": "GetUploadedFileType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/@types/node/globals.d.ts", + "qualifiedName": "NodeJS.ReadableStream" + }, + "name": "ReadableStream", + "package": "@types/node", + "qualifiedName": "NodeJS.ReadableStream" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 17, + "name": "getPresignedDownloadUrl", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 18, + "name": "getPresignedDownloadUrl", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a download URL of the file. For some file services, such as S3, a presigned URL indicates a temporary URL to get access to a file.\n\nIf your file service doesn’t perform or offer a similar functionality, you can just return the URL to download the file." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The presigned URL to download the file" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n\n async getPresignedDownloadUrl({\n fileKey,\n isPrivate = true,\n }: GetUploadedFileType\n ): Promise {\n // Local upload doesn't provide\n // support for presigned URLs,\n // so just return the file's URL.\n\n const filePath = `${isPrivate ?\n this.publicPath : this.protectedPath\n }/${fileKey}`\n return `${this.serverUrl}/${filePath}`\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 19, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "GetUploadedFileType" + }, + "name": "GetUploadedFileType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 20, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 21, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 22, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 23, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + { + "id": 24, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 25, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 26, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 27, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 28, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 29, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.withTransaction" + } + }, + { + "id": 30, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 31, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 32, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 33, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 34, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 34 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + }, + { + "id": 35, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 36, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 37, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 38, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 39, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 40, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 41, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 42, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 37, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 43, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 44, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 45, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 46, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 38, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 37, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 47, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 48, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 49, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 50, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 38, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 37, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 37, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 20, + 21, + 24, + 25, + 26 + ] + }, + { + "title": "Accessors", + "children": [ + 22 + ] + }, + { + "title": "Methods", + "children": [ + 2, + 5, + 8, + 11, + 14, + 17, + 27, + 30, + 35 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService" + }, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 51, + "name": "AbstractFileService" + } + ] + }, + { + "id": 51, + "name": "AbstractFileService", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 56, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 57, + "name": "new AbstractFileService", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your file service to access the different services in Medusa through dependency injection.\n\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs,\nyou can initialize it in the constructor and use it in other methods in the service.\n\nAdditionally, if you’re creating your file service as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin,\nyou can access them in the constructor." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport { Logger } from \"@medusajs/medusa\"\nimport * as fs from \"fs\"\n\nclass LocalFileService extends AbstractFileService {\n // can also be replaced by an environment variable\n // or a plugin option\n protected serverUrl = \"http://localhost:9000\"\n protected publicPath = \"uploads\"\n protected protectedPath = \"protected-uploads\"\n protected logger_: Logger\n\n constructor({ logger }: InjectedDependencies) {\n // @ts-ignore\n super(...arguments)\n this.logger_ = logger\n\n // for public uploads\n if (!fs.existsSync(this.publicPath)) {\n fs.mkdirSync(this.publicPath)\n }\n\n // for protected uploads\n if (!fs.existsSync(this.protectedPath)) {\n fs.mkdirSync(this.protectedPath)\n }\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 58, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "MedusaContainer" + }, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 59, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this file service is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 51, + "name": "AbstractFileService", + "package": "@medusajs/medusa" + }, + "overwrites": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 60, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "MedusaContainer" + }, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 61, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this file service is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 62, + "name": "upload", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 63, + "name": "upload", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to upload a file to the Medusa backend." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the upload's result." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n // ...\n async upload(\n fileData: Express.Multer.File\n ): Promise {\n const filePath =\n `${this.publicPath}/${fileData.originalname}`\n fs.copyFileSync(fileData.path, filePath)\n return {\n url: `${this.serverUrl}/${filePath}`,\n key: filePath,\n }\n }\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::tip\n\nThis example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name.\n\n:::" + } + ] + } + ] + }, + "parameters": [ + { + "id": 64, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A [multer file object](http://expressjs.com/en/resources/middleware/multer.html#file-information).\nThe file is uploaded to a temporary directory by default. Among the file’s details, you can access the file’s path in the " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": " property of the file object." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/multer/index.d.ts", + "qualifiedName": "__global.Express.Multer.File" + }, + "name": "File", + "package": "@types/multer", + "qualifiedName": "__global.Express.Multer.File" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "FileServiceUploadResult" + }, + "name": "FileServiceUploadResult", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3, + "name": "IFileService.upload" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2, + "name": "IFileService.upload" + } + }, + { + "id": 65, + "name": "uploadProtected", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 66, + "name": "uploadProtected", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to upload a file to the Medusa backend, but to a protected storage. Typically, this would be used to store files that\nshouldn’t be accessible by using the file’s URL or should only be accessible by authenticated users. For example, exported or imported\nCSV files." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The details of the upload's result." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n // ...\n async uploadProtected(\n fileData: Express.Multer.File\n ): Promise {\n const filePath =\n `${this.protectedPath}/${fileData.originalname}`\n fs.copyFileSync(fileData.path, filePath)\n return {\n url: `${this.serverUrl}/${filePath}`,\n key: filePath\n }\n }\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::tip\n\nThis example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name.\n\n:::" + } + ] + } + ] + }, + "parameters": [ + { + "id": 67, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A [multer file object](http://expressjs.com/en/resources/middleware/multer.html#file-information).\nThe file is uploaded to a temporary directory by default. Among the file’s details, you can access the file’s path in the " + }, + { + "kind": "code", + "text": "`path`" + }, + { + "kind": "text", + "text": " property of the file object." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/@types/multer/index.d.ts", + "qualifiedName": "__global.Express.Multer.File" + }, + "name": "File", + "package": "@types/multer", + "qualifiedName": "__global.Express.Multer.File" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "FileServiceUploadResult" + }, + "name": "FileServiceUploadResult", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 6, + "name": "IFileService.uploadProtected" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 5, + "name": "IFileService.uploadProtected" + } + }, + { + "id": 68, + "name": "delete", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 69, + "name": "delete", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to delete a file from storage." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Resolves when the file is deleted successfully." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n\n async delete(\n fileData: DeleteFileType\n ): Promise {\n fs.rmSync(fileData.fileKey)\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 70, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file to remove." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "DeleteFileType" + }, + "name": "DeleteFileType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 9, + "name": "IFileService.delete" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 8, + "name": "IFileService.delete" + } + }, + { + "id": 71, + "name": "getUploadStreamDescriptor", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 72, + "name": "getUploadStreamDescriptor", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a write stream to be used to upload a file." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The result of the file-stream upload." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport { Stream } from \"stream\"\n\nclass LocalFileService extends AbstractFileService {\n // ...\n async getUploadStreamDescriptor({\n name,\n ext,\n isPrivate = true,\n }: UploadStreamDescriptorType\n ): Promise {\n const filePath = `${isPrivate ?\n this.publicPath : this.protectedPath\n }/${name}.${ext}`\n\n const pass = new Stream.PassThrough()\n const writeStream = fs.createWriteStream(filePath)\n\n pass.pipe(writeStream)\n\n return {\n writeStream: pass,\n promise: Promise.resolve(),\n url: `${this.serverUrl}/${filePath}`,\n fileKey: filePath,\n }\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 73, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file being uploaded." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "UploadStreamDescriptorType" + }, + "name": "UploadStreamDescriptorType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "FileServiceGetUploadStreamResult" + }, + "name": "FileServiceGetUploadStreamResult", + "package": "@medusajs/types" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 12, + "name": "IFileService.getUploadStreamDescriptor" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 11, + "name": "IFileService.getUploadStreamDescriptor" + } + }, + { + "id": 74, + "name": "getDownloadStream", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 75, + "name": "getDownloadStream", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a read stream for a file, which can then be used to download the file." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The [read stream](https://nodejs.org/api/webstreams.html#class-readablestream) to read and download the file." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n\n async getDownloadStream({\n fileKey,\n isPrivate = true,\n }: GetUploadedFileType\n ): Promise {\n const filePath = `${isPrivate ?\n this.publicPath : this.protectedPath\n }/${fileKey}`\n const readStream = fs.createReadStream(filePath)\n\n return readStream\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 76, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "GetUploadedFileType" + }, + "name": "GetUploadedFileType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/@types/node/globals.d.ts", + "qualifiedName": "NodeJS.ReadableStream" + }, + "name": "ReadableStream", + "package": "@types/node", + "qualifiedName": "NodeJS.ReadableStream" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 15, + "name": "IFileService.getDownloadStream" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 14, + "name": "IFileService.getDownloadStream" + } + }, + { + "id": 77, + "name": "getPresignedDownloadUrl", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 78, + "name": "getPresignedDownloadUrl", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve a download URL of the file. For some file services, such as S3, a presigned URL indicates a temporary URL to get access to a file.\n\nIf your file service doesn’t perform or offer a similar functionality, you can just return the URL to download the file." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The presigned URL to download the file" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass LocalFileService extends AbstractFileService {\n\n async getPresignedDownloadUrl({\n fileKey,\n isPrivate = true,\n }: GetUploadedFileType\n ): Promise {\n // Local upload doesn't provide\n // support for presigned URLs,\n // so just return the file's URL.\n\n const filePath = `${isPrivate ?\n this.publicPath : this.protectedPath\n }/${fileKey}`\n return `${this.serverUrl}/${filePath}`\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 79, + "name": "fileData", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of the file." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/file-service/index.ts", + "qualifiedName": "GetUploadedFileType" + }, + "name": "GetUploadedFileType", + "package": "@medusajs/types" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 18, + "name": "IFileService.getPresignedDownloadUrl" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 17, + "name": "IFileService.getPresignedDownloadUrl" + } + }, + { + "id": 80, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.manager_" + }, + "implementationOf": { + "type": "reference", + "target": 20, + "name": "IFileService.manager_" + } + }, + { + "id": 81, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.transactionManager_" + }, + "implementationOf": { + "type": "reference", + "target": 21, + "name": "IFileService.transactionManager_" + } + }, + { + "id": 84, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__container__" + }, + "implementationOf": { + "type": "reference", + "target": 24, + "name": "IFileService.__container__" + } + }, + { + "id": 85, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__configModule__" + }, + "implementationOf": { + "type": "reference", + "target": 25, + "name": "IFileService.__configModule__" + } + }, + { + "id": 86, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__moduleDeclaration__" + }, + "implementationOf": { + "type": "reference", + "target": 26, + "name": "IFileService.__moduleDeclaration__" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 56 + ] + }, + { + "title": "Properties", + "children": [ + 60, + 61, + 80, + 81, + 84, + 85, + 86 + ] + }, + { + "title": "Methods", + "children": [ + 62, + 65, + 68, + 71, + 74, + 77 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService" + }, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 1, + "name": "IFileService", + "package": "@medusajs/medusa" + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "children": [ + 51 + ] + }, + { + "title": "Interfaces", + "children": [ + 1 + ] + } + ], + "packageName": "@medusajs/medusa", + "symbolIdMap": { + "0": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "" + }, + "1": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService" + }, + "2": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService.upload" + }, + "3": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService.upload" + }, + "4": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "file" + }, + "5": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService.uploadProtected" + }, + "6": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService.uploadProtected" + }, + "7": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "file" + }, + "8": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService.delete" + }, + "9": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService.delete" + }, + "10": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "fileData" + }, + "11": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService.getUploadStreamDescriptor" + }, + "12": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService.getUploadStreamDescriptor" + }, + "13": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "fileData" + }, + "14": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService.getDownloadStream" + }, + "15": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService.getDownloadStream" + }, + "16": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "fileData" + }, + "17": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService.getPresignedDownloadUrl" + }, + "18": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "IFileService.getPresignedDownloadUrl" + }, + "19": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "fileData" + }, + "20": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.manager_" + }, + "21": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.transactionManager_" + }, + "22": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "23": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "24": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__container__" + }, + "25": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__configModule__" + }, + "26": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + }, + "27": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "28": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "29": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "30": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "31": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "32": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "err" + }, + "33": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "34": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type.code" + }, + "35": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "36": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "37": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TResult" + }, + "38": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TError" + }, + "39": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "work" + }, + "40": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "41": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "42": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "43": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "isolationOrErrorHandler" + }, + "44": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "45": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "46": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "47": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "maybeErrorHandlerOrDontFail" + }, + "48": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "49": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "50": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "51": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService" + }, + "56": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.__constructor" + }, + "57": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService" + }, + "58": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "container" + }, + "59": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "config" + }, + "60": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.container" + }, + "61": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.config" + }, + "62": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.upload" + }, + "63": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.upload" + }, + "64": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "fileData" + }, + "65": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.uploadProtected" + }, + "66": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.uploadProtected" + }, + "67": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "fileData" + }, + "68": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.delete" + }, + "69": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.delete" + }, + "70": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "fileData" + }, + "71": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.getUploadStreamDescriptor" + }, + "72": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.getUploadStreamDescriptor" + }, + "73": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "fileData" + }, + "74": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.getDownloadStream" + }, + "75": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.getDownloadStream" + }, + "76": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "fileData" + }, + "77": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.getPresignedDownloadUrl" + }, + "78": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "AbstractFileService.getPresignedDownloadUrl" + }, + "79": { + "sourceFileName": "../../../packages/medusa/src/interfaces/file-service.ts", + "qualifiedName": "fileData" + }, + "80": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.manager_" + }, + "81": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.transactionManager_" + }, + "82": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "83": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "84": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__container__" + }, + "85": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__configModule__" + }, + "86": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + }, + "87": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "88": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "89": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "90": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "91": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "92": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "err" + }, + "93": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "94": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type.code" + }, + "95": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "96": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "97": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TResult" + }, + "98": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TError" + }, + "99": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "work" + }, + "100": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "101": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "102": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "103": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "isolationOrErrorHandler" + }, + "104": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "105": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "106": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "107": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "maybeErrorHandlerOrDontFail" + }, + "108": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "109": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "110": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + } + } +} \ No newline at end of file diff --git a/docs-util/typedoc-json-output/medusa-config.json b/docs-util/typedoc-json-output/medusa-config.json new file mode 100644 index 0000000000..a2528a5da2 --- /dev/null +++ b/docs-util/typedoc-json-output/medusa-config.json @@ -0,0 +1,1840 @@ +{ + "id": 0, + "name": "medusa-config", + "variant": "project", + "kind": 1, + "flags": {}, + "children": [ + { + "id": 1, + "name": "HttpCompressionOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "HTTP compression configurations." + } + ] + }, + "children": [ + { + "id": 2, + "name": "enabled", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether HTTP compression is enabled. By default, it's " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 3, + "name": "level", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The level of zlib compression to apply to responses. A higher level will result in better compression but will take longer to complete. \nA lower level will result in less compression but will be much faster. The default value is " + }, + { + "kind": "code", + "text": "`6`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 4, + "name": "memLevel", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "How much memory should be allocated to the internal compression state. It's an integer in the range of 1 (minimum level) and 9 (maximum level). \nThe default value is " + }, + { + "kind": "code", + "text": "`8`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 5, + "name": "threshold", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The minimum response body size that compression is applied on. Its value can be the number of bytes or any string accepted by the \n[bytes](https://www.npmjs.com/package/bytes) module. The default value is " + }, + { + "kind": "code", + "text": "`1024`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2, + 3, + 4, + 5 + ] + } + ] + }, + { + "id": 6, + "name": "ProjectConfigOptions", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Essential configurations related to the Medusa backend, such as database and CORS configurations." + } + ] + }, + "children": [ + { + "id": 7, + "name": "store_cors", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n" + }, + { + "kind": "code", + "text": "`store_cors`" + }, + { + "kind": "text", + "text": " is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins. \n\nEvery origin in that list must either be:\n\n1. A URL. For example, " + }, + { + "kind": "code", + "text": "`http://localhost:8000`" + }, + { + "kind": "text", + "text": ". The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, " + }, + { + "kind": "code", + "text": "`.example.com`" + }, + { + "kind": "text", + "text": ". The regex pattern that the backend tests for is " + }, + { + "kind": "code", + "text": "`^([/~@;%#'])(.*?)\\1([gimsuy]*)$`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Some example values of common use cases:\n\n" + }, + { + "kind": "code", + "text": "```bash\n# Allow different ports locally starting with 800\nSTORE_CORS=/http://localhost:800\\d+$/\n\n# Allow any origin ending with vercel.app. For example, storefront.vercel.app\nSTORE_CORS=/vercel\\.app$/\n\n# Allow all HTTP requests\nSTORE_CORS=/http://.+/\n```" + }, + { + "kind": "text", + "text": "\n\nThen, set the configuration in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ":\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n store_cors: process.env.STORE_CORS,\n // ...\n },\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\nIf you’re adding the value directly within " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ", make sure to add an extra escaping " + }, + { + "kind": "code", + "text": "`/`" + }, + { + "kind": "text", + "text": " for every backslash in the pattern. For example:\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n store_cors: \"/vercel\\\\.app$/\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 8, + "name": "admin_cors", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes.\n\n" + }, + { + "kind": "code", + "text": "`admin_cors`" + }, + { + "kind": "text", + "text": " is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins. \n\nEvery origin in that list must either be:\n\n1. A URL. For example, " + }, + { + "kind": "code", + "text": "`http://localhost:7001`" + }, + { + "kind": "text", + "text": ". The URL must not end with a backslash;\n2. Or a regular expression pattern that can match more than one origin. For example, " + }, + { + "kind": "code", + "text": "`.example.com`" + }, + { + "kind": "text", + "text": ". The regex pattern that the backend tests for is " + }, + { + "kind": "code", + "text": "`^([/~@;%#'])(.*?)\\1([gimsuy]*)$`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "Some example values of common use cases:\n\n" + }, + { + "kind": "code", + "text": "```bash\n# Allow different ports locally starting with 700\nADMIN_CORS=/http://localhost:700\\d+$/\n\n# Allow any origin ending with vercel.app. For example, admin.vercel.app\nADMIN_CORS=/vercel\\.app$/\n\n# Allow all HTTP requests\nADMIN_CORS=/http://.+/\n```" + }, + { + "kind": "text", + "text": "\n\nThen, set the configuration in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ":\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n admin_cors: process.env.ADMIN_CORS,\n // ...\n },\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\nIf you’re adding the value directly within " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ", make sure to add an extra escaping " + }, + { + "kind": "code", + "text": "`/`" + }, + { + "kind": "text", + "text": " for every backslash in the pattern. For example:\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n admin_cors: \"/http:\\\\/\\\\/localhost:700\\\\d+$/\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 9, + "name": "cookie_secret", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A random string used to create cookie tokens. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set, the default secret is " + }, + { + "kind": "code", + "text": "`supersecret`" + }, + { + "kind": "text", + "text": " However, in production, if this configuration is not set, an error is thrown and \nthe backend crashes." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n cookie_secret: process.env.COOKIE_SECRET ||\n \"supersecret\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 10, + "name": "jwt_secret", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A random string used to create authentication tokens. Although this configuration option is not required, it’s highly recommended to set it for better security.\n\nIn a development environment, if this option is not set the default secret is " + }, + { + "kind": "code", + "text": "`supersecret`" + }, + { + "kind": "text", + "text": " However, in production, if this configuration is not set an error, an\nerror is thrown and the backend crashes." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n jwt_secret: process.env.JWT_SECRET ||\n \"supersecret\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 11, + "name": "database_database", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the database to connect to. If specified in " + }, + { + "kind": "code", + "text": "`database_url`" + }, + { + "kind": "text", + "text": ", then it’s not required to include it.\n\nMake sure to create the PostgreSQL database before using it. You can check how to create a database in \n[PostgreSQL's documentation](https://www.postgresql.org/docs/current/sql-createdatabase.html)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_database: process.env.DATABASE_DATABASE || \n \"medusa-store\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 12, + "name": "database_url", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The connection URL of the database. The format of the connection URL for PostgreSQL is:\n\n" + }, + { + "kind": "code", + "text": "```bash\npostgres://[user][:password]@[host][:port]/[dbname]\n```" + }, + { + "kind": "text", + "text": "\n\nWhere:\n\n- " + }, + { + "kind": "code", + "text": "`[user]`" + }, + { + "kind": "text", + "text": ": (required) your PostgreSQL username. If not specified, the system's username is used by default. The database user that you use must have create privileges. If you're using the " + }, + { + "kind": "code", + "text": "`postgres`" + }, + { + "kind": "text", + "text": " superuser, then it should have these privileges by default. Otherwise, make sure to grant your user create privileges. You can learn how to do that in [PostgreSQL's documentation](https://www.postgresql.org/docs/current/ddl-priv.html).\n- " + }, + { + "kind": "code", + "text": "`[:password]`" + }, + { + "kind": "text", + "text": ": an optional password for the user. When provided, make sure to put " + }, + { + "kind": "code", + "text": "`:`" + }, + { + "kind": "text", + "text": " before the password.\n- " + }, + { + "kind": "code", + "text": "`[host]`" + }, + { + "kind": "text", + "text": ": (required) your PostgreSQL host. When run locally, it should be " + }, + { + "kind": "code", + "text": "`localhost`" + }, + { + "kind": "text", + "text": ".\n- " + }, + { + "kind": "code", + "text": "`[:post]`" + }, + { + "kind": "text", + "text": ": an optional port that the PostgreSQL server is listening on. By default, it's " + }, + { + "kind": "code", + "text": "`5432`" + }, + { + "kind": "text", + "text": ". When provided, make sure to put " + }, + { + "kind": "code", + "text": "`:`" + }, + { + "kind": "text", + "text": " before the port.\n- " + }, + { + "kind": "code", + "text": "`[dbname]`" + }, + { + "kind": "text", + "text": ": (required) the name of the database.\n\nYou can learn more about the connection URL format in [PostgreSQL’s documentation](https://www.postgresql.org/docs/current/libpq-connect.html)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, set the following database URL in your environment variables:\n\n" + }, + { + "kind": "code", + "text": "```bash\nDATABASE_URL=postgres://postgres@localhost/medusa-store\n```" + }, + { + "kind": "text", + "text": "\n\nThen, use the value in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ":\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_url: process.env.DATABASE_URL,\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 13, + "name": "database_schema", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The database schema to connect to. This is not required to provide if you’re using the default schema, which is " + }, + { + "kind": "code", + "text": "`public`" + }, + { + "kind": "text", + "text": ".\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_schema: process.env.DATABASE_SCHEMA || \n \"custom\",\n // ...\n },\n // ...\n}\n```" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 14, + "name": "database_logging", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This configuration specifies what database messages to log. Its value can be one of the following:\n\n- (default) A boolean value that indicates whether any messages should be logged.\n- The string value " + }, + { + "kind": "code", + "text": "`all`" + }, + { + "kind": "text", + "text": " that indicates all types of messages should be logged.\n- An array of log-level strings to indicate which type of messages to show in the logs. The strings can be " + }, + { + "kind": "code", + "text": "`query`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`schema`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`error`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`warn`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`info`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`log`" + }, + { + "kind": "text", + "text": ", or " + }, + { + "kind": "code", + "text": "`migration`" + }, + { + "kind": "text", + "text": ". Refer to [Typeorm’s documentation](https://typeorm.io/logging#logging-options) for more details on what each of these values means.\n\nIf this configuration isn't set, its default value is " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ", meaning no database messages are logged." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_logging: [\n \"query\", \"error\",\n ],\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/logger/LoggerOptions.d.ts", + "qualifiedName": "LoggerOptions" + }, + "name": "LoggerOptions", + "package": "typeorm" + } + }, + { + "id": 16, + "name": "database_extra", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object that includes additional configurations to pass to the database connection. You can pass any configuration. One defined configuration to pass is \n" + }, + { + "kind": "code", + "text": "`ssl`" + }, + { + "kind": "text", + "text": " which enables support for TLS/SSL connections.\n\nThis is useful for production databases, which can be supported by setting the " + }, + { + "kind": "code", + "text": "`rejectUnauthorized`" + }, + { + "kind": "text", + "text": " attribute of " + }, + { + "kind": "code", + "text": "`ssl`" + }, + { + "kind": "text", + "text": " object to " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": ". \nDuring development, it’s recommended not to pass this option." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n database_extra: \n process.env.NODE_ENV !== \"development\"\n ? { ssl: { rejectUnauthorized: false } }\n : {},\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intersection", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 17, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 18, + "name": "ssl", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure support for TLS/SSL connection" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 19, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 20, + "name": "rejectUnauthorized", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to fail connection if the server certificate is verified against the list of supplied CAs and the hostname and no match is found." + } + ] + }, + "type": { + "type": "literal", + "value": false + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 20 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 18 + ] + } + ] + } + } + ] + } + }, + { + "id": 21, + "name": "redis_url", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Used to specify the URL to connect to Redis. This is only used for scheduled jobs. If you omit this configuration, scheduled jobs won't work.\n\n:::note\n\nYou must first have Redis installed. You can refer to [Redis's installation guide](https://redis.io/docs/getting-started/installation/).\n\n:::\n\nThe Redis connection URL has the following format:\n\n" + }, + { + "kind": "code", + "text": "```bash\nredis[s]://[[username][:password]@][host][:port][/db-number]\n```" + }, + { + "kind": "text", + "text": "\n\nFor a local Redis installation, the connection URL should be " + }, + { + "kind": "code", + "text": "`redis://localhost:6379`" + }, + { + "kind": "text", + "text": " unless you’ve made any changes to the Redis configuration during installation." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n redis_url: process.env.REDIS_URL || \n \"redis://localhost:6379\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 22, + "name": "redis_prefix", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The prefix set on all keys stored in Redis. The default value is " + }, + { + "kind": "code", + "text": "`sess:`" + }, + { + "kind": "text", + "text": ". \n\nIf this configuration option is provided, it is prepended to " + }, + { + "kind": "code", + "text": "`sess:`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n redis_prefix: process.env.REDIS_PREFIX || \n \"medusa:\",\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 23, + "name": "redis_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object of options to pass ioredis. You can refer to [ioredis’s RedisOptions documentation](https://redis.github.io/ioredis/index.html#RedisOptions) \nfor the list of available options." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n redis_options: {\n connectionName: process.env.REDIS_CONNECTION_NAME || \n \"medusa\",\n },\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/ioredis/built/redis/RedisOptions.d.ts", + "qualifiedName": "RedisOptions" + }, + "name": "RedisOptions", + "package": "ioredis" + } + }, + { + "id": 24, + "name": "session_options", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An object of options to pass to [express-session](https://www.npmjs.com/package/express-session)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n session_options: {\n name: process.env.SESSION_NAME || \n \"custom\",\n },\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "SessionOptions" + }, + "name": "SessionOptions", + "package": "@medusajs/types" + } + }, + { + "id": 25, + "name": "http_compression", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there. \nHowever, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative.\n\nIts value is an object that has the following properties:\n\nIf you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header " + }, + { + "kind": "code", + "text": "`\"x-no-compression\": true`" + }, + { + "kind": "text", + "text": "." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig: {\n http_compression: {\n enabled: true,\n level: 6,\n memLevel: 8,\n threshold: 1024,\n },\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": 1, + "name": "HttpCompressionOptions", + "package": "@medusajs/types" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 16, + 21, + 22, + 23, + 24, + 25 + ] + } + ] + }, + { + "id": 26, + "name": "ConfigModule", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The configurations for your Medusa backend are in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": " located in the root of your Medusa project. The configurations include database, modules, and plugin configurations, among other configurations.\n\n" + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": " exports an object having the following properties:\n\n- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "projectConfig", + "target": 27, + "tsLinkText": "projectConfig" + }, + { + "kind": "text", + "text": ": (required): An object that holds general configurations related to the Medusa backend, such as database or CORS configurations.\n- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "plugins", + "target": 28, + "tsLinkText": "plugins" + }, + { + "kind": "text", + "text": ": An array of plugin configurations that defines what plugins are installed and optionally specifies each of their configurations.\n- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "modules", + "target": 32, + "tsLinkText": "modules" + }, + { + "kind": "text", + "text": ": An object that defines what modules are installed and optionally specifies each of their configurations.\n- " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "featureFlags", + "target": 33, + "tsLinkText": "featureFlags" + }, + { + "kind": "text", + "text": ": An object that enables or disables features guarded by a feature flag.\n\nFor example:\n\n" + }, + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n projectConfig,\n plugins,\n modules,\n featureFlags,\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---\n\n## Environment Variables\n\nIt's highly recommended to store the values of configurations in environment variables, then reference them within " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ".\n\nDuring development, you can set your environment variables in the " + }, + { + "kind": "code", + "text": "`.env`" + }, + { + "kind": "text", + "text": " file at the root of your Medusa backend project. In production, \nsetting the environment variables depends on the hosting provider.\n\n---" + } + ] + }, + "children": [ + { + "id": 27, + "name": "projectConfig", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This property holds essential configurations related to the Medusa backend, such as database and CORS configurations." + } + ] + }, + "type": { + "type": "reference", + "target": 6, + "name": "ProjectConfigOptions", + "package": "@medusajs/types" + } + }, + { + "id": 28, + "name": "plugins", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "On your Medusa backend, you can use [Plugins](https://docs.medusajs.com/development/plugins/overview) to add custom features or integrate third-party services. \nFor example, installing a plugin to use Stripe as a payment processor.\n\nAside from installing the plugin with NPM, you need to pass the plugin you installed into the " + }, + { + "kind": "code", + "text": "`plugins`" + }, + { + "kind": "text", + "text": " array defined in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ".\n\nThe items in the array can either be:\n\n- A string, which is the name of the plugin to add. You can pass a plugin as a string if it doesn’t require any configurations.\n- An object having the following properties:\n - " + }, + { + "kind": "code", + "text": "`resolve`" + }, + { + "kind": "text", + "text": ": The name of the plugin.\n - " + }, + { + "kind": "code", + "text": "`options`" + }, + { + "kind": "text", + "text": ": An object that includes the plugin’s options. These options vary for each plugin, and you should refer to the plugin’s documentation for available options." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n plugins: [\n `medusa-my-plugin-1`,\n {\n resolve: `medusa-my-plugin`,\n options: {\n apiKey: process.env.MY_API_KEY || \n `test`,\n },\n },\n // ...\n ],\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reflection", + "declaration": { + "id": 29, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 30, + "name": "resolve", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 31, + "name": "options", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 30, + 31 + ] + } + ] + } + } + ] + } + } + }, + { + "id": 32, + "name": "modules", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "In Medusa, commerce and core logic are modularized to allow developers to extend or replace certain [modules](https://docs.medusajs.com/development/modules/overview) \nwith custom implementations.\n\nAside from installing the module with NPM, you must add it to the exported object in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ".\n\nThe keys of the " + }, + { + "kind": "code", + "text": "`modules`" + }, + { + "kind": "text", + "text": " configuration object refer to the type of module. Its value can be one of the following:\n\n1. A boolean value indicating whether the module type is enabled;\n2. Or a string value indicating the name of the module to be used for the module type. This can be used if the module does not require any options;\n3. Or an object having the following properties, but typically you would mainly use the " + }, + { + "kind": "code", + "text": "`resolve`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`options`" + }, + { + "kind": "text", + "text": " properties only:\n 1. " + }, + { + "kind": "code", + "text": "`resolve`" + }, + { + "kind": "text", + "text": ": a string indicating the name of the module.\n 2. " + }, + { + "kind": "code", + "text": "`options`" + }, + { + "kind": "text", + "text": ": an object indicating the options to pass to the module. These options vary for each module, and you should refer to the module’s documentation for details on them.\n 3. " + }, + { + "kind": "code", + "text": "`resources`" + }, + { + "kind": "text", + "text": ": a string indicating whether the module shares the dependency container with the Medusa core. Its value can either be " + }, + { + "kind": "code", + "text": "`shared`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`isolated`" + }, + { + "kind": "text", + "text": ". Refer to the [Modules documentation](https://docs.medusajs.com/development/modules/create#module-scope) for more details.\n 4. " + }, + { + "kind": "code", + "text": "`alias`" + }, + { + "kind": "text", + "text": ": a string indicating a unique alias to register the module under. Other modules can’t use the same alias.\n 5. " + }, + { + "kind": "code", + "text": "`main`" + }, + { + "kind": "text", + "text": ": a boolean value indicating whether this module is the main registered module. This is useful when an alias is used." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n modules: {\n eventBus: {\n resolve: \"@medusajs/event-bus-local\",\n },\n cacheService: {\n resolve: \"@medusajs/cache-redis\",\n options: { \n redisUrl: process.env.CACHE_REDIS_URL,\n ttl: 30,\n },\n },\n // ...\n },\n // ...\n}\n```" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "boolean" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Partial" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "InternalModuleDeclaration" + }, + "name": "InternalModuleDeclaration", + "package": "@medusajs/types" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/modules-sdk/index.ts", + "qualifiedName": "ExternalModuleDeclaration" + }, + "name": "ExternalModuleDeclaration", + "package": "@medusajs/types" + } + ] + } + ], + "name": "Partial", + "package": "typescript" + } + ] + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 33, + "name": "featureFlags", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Some features in the Medusa backend are guarded by a feature flag. This ensures constant shipping of new features while maintaining the engine’s stability.\n\nYou can specify whether a feature should or shouldn’t be used in your backend by enabling its feature flag. Feature flags can be enabled through either environment \nvariables or through this configuration exported in " + }, + { + "kind": "code", + "text": "`medusa-config.js`" + }, + { + "kind": "text", + "text": ".\n\nIf you want to use the environment variables method, learn more about it in the [Feature Flags documentation](https://docs.medusajs.com/development/feature-flags/toggle#method-one-using-environment-variables).\n\nThe " + }, + { + "kind": "code", + "text": "`featureFlags`" + }, + { + "kind": "text", + "text": " configuration is an object. Its properties are the names of the feature flags. Each property’s value is a boolean indicating whether the feature flag is enabled.\n\nYou can find available feature flags and their key name [here](https://github.com/medusajs/medusa/tree/master/packages/medusa/src/loaders/feature-flags)." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```js title=\"medusa-config.js\"\nmodule.exports = {\n featureFlags: {\n product_categories: true,\n // ...\n },\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::note\n\nAfter enabling a feature flag, make sure to [run migrations](https://docs.medusajs.com/development/entities/migrations/overview#migrate-command) as it may require making changes to the database.\n\n:::" + } + ] + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 27, + 28, + 32, + 33 + ] + } + ] + } + ], + "groups": [ + { + "title": "Interfaces", + "children": [ + 1, + 6, + 26 + ] + } + ], + "packageName": "@medusajs/types", + "symbolIdMap": { + "0": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "" + }, + "1": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "HttpCompressionOptions" + }, + "2": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.enabled" + }, + "3": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.level" + }, + "4": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.memLevel" + }, + "5": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.threshold" + }, + "6": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "ProjectConfigOptions" + }, + "7": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.store_cors" + }, + "8": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.admin_cors" + }, + "9": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.cookie_secret" + }, + "10": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.jwt_secret" + }, + "11": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_database" + }, + "12": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_url" + }, + "13": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_schema" + }, + "14": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_logging" + }, + "16": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.database_extra" + }, + "17": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type" + }, + "18": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.ssl" + }, + "19": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type" + }, + "20": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.rejectUnauthorized" + }, + "21": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.redis_url" + }, + "22": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.redis_prefix" + }, + "23": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.redis_options" + }, + "24": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.session_options" + }, + "25": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.http_compression" + }, + "26": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "ConfigModule" + }, + "27": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.projectConfig" + }, + "28": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.plugins" + }, + "29": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type" + }, + "30": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.resolve" + }, + "31": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.options" + }, + "32": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.modules" + }, + "33": { + "sourceFileName": "../../../packages/types/src/common/config-module.ts", + "qualifiedName": "__type.featureFlags" + } + } +} \ No newline at end of file diff --git a/docs-util/typedoc-json-output/notification.json b/docs-util/typedoc-json-output/notification.json new file mode 100644 index 0000000000..83d1ea75af --- /dev/null +++ b/docs-util/typedoc-json-output/notification.json @@ -0,0 +1,2609 @@ +{ + "id": 0, + "name": "notification", + "variant": "project", + "kind": 1, + "flags": {}, + "children": [ + { + "id": 1, + "name": "ReturnedData", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The details of a sent or resent notification." + } + ] + }, + "children": [ + { + "id": 2, + "name": "to", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The receiver of the Notification. For example, if you sent an email to the customer then " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " is the email address of the customer.\nIn other cases, it might be a phone number or a username." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 3, + "name": "status", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The status of the sent notification. There are no restriction on the returned status." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 4, + "name": "data", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data used to send the Notification. For example, if you sent an order confirmation email to the customer, then the " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " object\nmight include the order items or the subject of the email. This " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " is necessary if the notification is resent later as you can use the same data." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 2, + 3, + 4 + ] + } + ] + }, + { + "id": 5, + "name": "INotificationService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\n:::note[Prerequisites]\n\nBefore creating a Notification Provider, [install an event bus module](https://docs.medusajs.com/development/events/modules/redis).\n\n:::\n\nA Notification Provider is a provider that handles sending and resending of notifications.\n\nTo create a Notification Provider, create a TypeScript or JavaScript file in " + }, + { + "kind": "code", + "text": "`src/services`" + }, + { + "kind": "text", + "text": ". The name of the file is the name of the provider\n(for example, " + }, + { + "kind": "code", + "text": "`sendgrid.ts`" + }, + { + "kind": "text", + "text": "). The file must export a class that extends the " + }, + { + "kind": "code", + "text": "`AbstractNotificationService`" + }, + { + "kind": "text", + "text": " class imported from " + }, + { + "kind": "code", + "text": "`@medusajs/medusa`" + }, + { + "kind": "text", + "text": ".\n\nFor example, create the file " + }, + { + "kind": "code", + "text": "`src/services/email-sender.ts`" + }, + { + "kind": "text", + "text": " with the following content:\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/services/email-sender.ts\"\nimport { AbstractNotificationService } from \"@medusajs/medusa\"\nimport { EntityManager } from \"typeorm\"\n\nclass EmailSenderService extends AbstractNotificationService {\n protected manager_: EntityManager\n protected transactionManager_: EntityManager\n\n sendNotification(\n event: string,\n data: unknown,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record;\n }> {\n throw new Error(\"Method not implemented.\")\n }\n resendNotification(\n notification: unknown,\n config: unknown,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record;\n }> {\n throw new Error(\"Method not implemented.\")\n }\n\n}\n\nexport default EmailSenderService\n```" + }, + { + "kind": "text", + "text": "\n\n---\n\n## Identifier Property\n\nThe " + }, + { + "kind": "code", + "text": "`NotificationProvider`" + }, + { + "kind": "text", + "text": " entity has 2 properties: " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`is_installed`" + }, + { + "kind": "text", + "text": ". The value of the " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " property in the notification provider\nclass is used when the Notification Provider is created in the database.\n\nThe value of this property is also used later when you want to subscribe the Notification Provider to events in a [Loader](https://docs.medusajs.com/development/loaders/overview).\n\nFor example:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass EmailSenderService extends AbstractNotificationService {\n static identifier = \"email-sender\"\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---" + } + ] + }, + "children": [ + { + "id": 6, + "name": "sendNotification", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 7, + "name": "sendNotification", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When an event is triggered that your Notification Provider is registered as a handler for, the [" + }, + { + "kind": "code", + "text": "`NotificationService`" + }, + { + "kind": "text", + "text": "](https://docs.medusajs.com/references/services/classes/services.NotificationService)\nin the Medusa backend executes this method of your Notification Provider.\n\nIn this method, you can perform the necessary operation to send the Notification. For example, you can send an email to the customer when they place an order." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The sending details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass EmailSenderService extends AbstractNotificationService {\n // ...\n async sendNotification(\n event: string,\n data: any,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record;\n }> {\n if (event === \"order.placed\") {\n // retrieve order\n const order = await this.orderService.retrieve(data.id)\n // TODO send email\n\n console.log(\"Notification sent\")\n return {\n to: order.email,\n status: \"done\",\n data: {\n // any data necessary to send the email\n // for example:\n subject: \"You placed a new order!\",\n items: order.items,\n },\n }\n }\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 8, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the event that was triggered. For example, " + }, + { + "kind": "code", + "text": "`order.placed`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 9, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data payload of the event that was triggered. For example, if the " + }, + { + "kind": "code", + "text": "`order.placed`" + }, + { + "kind": "text", + "text": " event is triggered,\nthe " + }, + { + "kind": "code", + "text": "`eventData`" + }, + { + "kind": "text", + "text": " object contains the property " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " which is the ID of the order that was placed. You can refer to the\n[Events reference](https://docs.medusajs.com/development/events/events-list) for information on all events and their payloads." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 10, + "name": "attachmentGenerator", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If you’ve previously register an attachment generator to the " + }, + { + "kind": "code", + "text": "`NotificationService`" + }, + { + "kind": "text", + "text": " using the\n[" + }, + { + "kind": "code", + "text": "`registerAttachmentGenerator`" + }, + { + "kind": "text", + "text": "](https://docs.medusajs.com/references/services/classes/services.NotificationService#registerattachmentgenerator) method,\nyou have access to it here. You can use the " + }, + { + "kind": "code", + "text": "`attachmentGenerator`" + }, + { + "kind": "text", + "text": " to generate on-demand invoices or other documents. The default value of this parameter is " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1, + "name": "ReturnedData", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 11, + "name": "resendNotification", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 12, + "name": "resendNotification", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to resend notifications, which is typically triggered by the\n[Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The resend details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass EmailSenderService extends AbstractNotificationService {\n // ...\n async resendNotification(\n notification: any,\n config: any,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record;\n }> {\n // check if the receiver should be changed\n const to: string = config.to || notification.to\n\n // TODO resend the notification using the same data\n // that is saved under notification.data\n\n console.log(\"Notification resent\")\n return {\n to,\n status: \"done\",\n data: notification.data, // make changes to the data\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 13, + "name": "notification", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The original [Notification record](https://docs.medusajs.com/references/entities/classes/Notification) that was created after you sent the\nnotification with " + }, + { + "kind": "code", + "text": "`sendNotification`" + }, + { + "kind": "text", + "text": ". It includes the " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attributes which are populated originally using the " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " properties of\nthe object you return in " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "sendNotification", + "target": 6, + "tsLinkText": "" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 14, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new configuration used to resend the notification. The [Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend),\nallows you to pass a new " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " field. If specified, it will be available in this config object." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 15, + "name": "attachmentGenerator", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "f you’ve previously register an attachment generator to the " + }, + { + "kind": "code", + "text": "`NotificationService`" + }, + { + "kind": "text", + "text": " using the\n[" + }, + { + "kind": "code", + "text": "`registerAttachmentGenerator`" + }, + { + "kind": "text", + "text": "](https://docs.medusajs.com/references/services/classes/services.NotificationService#registerattachmentgenerator) method,\nyou have access to it here. You can use the " + }, + { + "kind": "code", + "text": "`attachmentGenerator`" + }, + { + "kind": "text", + "text": " to generate on-demand invoices or other documents. The default value of this parameter is " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1, + "name": "ReturnedData", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 16, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 17, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 18, + "name": "activeManager_", + "variant": "declaration", + "kind": 262144, + "flags": { + "isProtected": true + }, + "getSignature": { + "id": 19, + "name": "activeManager_", + "variant": "signature", + "kind": 524288, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.activeManager_" + } + }, + { + "id": 20, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 21, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 22, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 23, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 24, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 25, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.withTransaction" + } + }, + { + "id": 26, + "name": "shouldRetryTransaction_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 27, + "name": "shouldRetryTransaction_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 28, + "name": "err", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + { + "type": "reflection", + "declaration": { + "id": 29, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 30, + "name": "code", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 30 + ] + } + ] + } + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "boolean" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.shouldRetryTransaction_" + } + }, + { + "id": 31, + "name": "atomicPhase_", + "variant": "declaration", + "kind": 2048, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 32, + "name": "atomicPhase_", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Wraps some work within a transactional block. If the service already has\na transaction manager attached this will be reused, otherwise a new\ntransaction manager is created." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "the result of the transactional work" + } + ] + } + ] + }, + "typeParameter": [ + { + "id": 33, + "name": "TResult", + "variant": "typeParam", + "kind": 131072, + "flags": {} + }, + { + "id": 34, + "name": "TError", + "variant": "typeParam", + "kind": 131072, + "flags": {} + } + ], + "parameters": [ + { + "id": 35, + "name": "work", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the transactional work to be done" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 36, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 37, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 38, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 33, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + }, + { + "id": 39, + "name": "isolationOrErrorHandler", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "the isolation level to be used for the work." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/driver/types/IsolationLevel.d.ts", + "qualifiedName": "IsolationLevel" + }, + "name": "IsolationLevel", + "package": "typeorm" + }, + { + "type": "reflection", + "declaration": { + "id": 40, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 41, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 42, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 34, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 33, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + ] + } + }, + { + "id": 43, + "name": "maybeErrorHandlerOrDontFail", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Potential error handler" + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 44, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "signatures": [ + { + "id": 45, + "name": "__type", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 46, + "name": "error", + "variant": "param", + "kind": 32768, + "flags": {}, + "type": { + "type": "reference", + "target": 34, + "name": "TError", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "void" + }, + { + "type": "reference", + "target": 33, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ] + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 33, + "name": "TResult", + "package": "@medusajs/medusa", + "refersToTypeParameter": true + } + ], + "name": "Promise", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.atomicPhase_" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 16, + 17, + 20, + 21, + 22 + ] + }, + { + "title": "Accessors", + "children": [ + 18 + ] + }, + { + "title": "Methods", + "children": [ + 6, + 11, + 23, + 26, + 31 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService" + }, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 47, + "name": "AbstractNotificationService" + } + ] + }, + { + "id": 47, + "name": "AbstractNotificationService", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 49, + "name": "identifier", + "variant": "declaration", + "kind": 1024, + "flags": { + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 53, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 54, + "name": "new AbstractNotificationService", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your notification provider to access the different services in Medusa through dependency injection.\n\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs,\nyou can initialize it in the constructor and use it in other methods in the service.\n\nAdditionally, if you’re creating your notification provider as an external plugin to be installed on any Medusa backend and you want to access the options\nadded for the plugin, you can access it in the constructor." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport { AbstractNotificationService, OrderService } from \"@medusajs/medusa\"\nimport { EntityManager } from \"typeorm\"\n\nclass EmailSenderService extends AbstractNotificationService {\n // ...\n protected orderService: OrderService\n\n constructor(container, options) {\n super(container)\n // you can access options here in case you're\n // using a plugin\n\n this.orderService = container.orderService\n\n // you can also initialize a client that\n // communicates with a third-party service.\n this.client = new Client(options)\n }\n\n // ...\n}\n\nexport default EmailSenderService\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 55, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "MedusaContainer" + }, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 56, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this notification provider is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 47, + "name": "AbstractNotificationService", + "package": "@medusajs/medusa" + }, + "overwrites": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 59, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "MedusaContainer" + }, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 60, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this notification provider is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 61, + "name": "sendNotification", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 62, + "name": "sendNotification", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "When an event is triggered that your Notification Provider is registered as a handler for, the [" + }, + { + "kind": "code", + "text": "`NotificationService`" + }, + { + "kind": "text", + "text": "](https://docs.medusajs.com/references/services/classes/services.NotificationService)\nin the Medusa backend executes this method of your Notification Provider.\n\nIn this method, you can perform the necessary operation to send the Notification. For example, you can send an email to the customer when they place an order." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The sending details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass EmailSenderService extends AbstractNotificationService {\n // ...\n async sendNotification(\n event: string,\n data: any,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record;\n }> {\n if (event === \"order.placed\") {\n // retrieve order\n const order = await this.orderService.retrieve(data.id)\n // TODO send email\n\n console.log(\"Notification sent\")\n return {\n to: order.email,\n status: \"done\",\n data: {\n // any data necessary to send the email\n // for example:\n subject: \"You placed a new order!\",\n items: order.items,\n },\n }\n }\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 63, + "name": "event", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the event that was triggered. For example, " + }, + { + "kind": "code", + "text": "`order.placed`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 64, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The data payload of the event that was triggered. For example, if the " + }, + { + "kind": "code", + "text": "`order.placed`" + }, + { + "kind": "text", + "text": " event is triggered,\nthe " + }, + { + "kind": "code", + "text": "`eventData`" + }, + { + "kind": "text", + "text": " object contains the property " + }, + { + "kind": "code", + "text": "`id`" + }, + { + "kind": "text", + "text": " which is the ID of the order that was placed. You can refer to the\n[Events reference](https://docs.medusajs.com/development/events/events-list) for information on all events and their payloads." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 65, + "name": "attachmentGenerator", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If you’ve previously register an attachment generator to the " + }, + { + "kind": "code", + "text": "`NotificationService`" + }, + { + "kind": "text", + "text": " using the\n[" + }, + { + "kind": "code", + "text": "`registerAttachmentGenerator`" + }, + { + "kind": "text", + "text": "](https://docs.medusajs.com/references/services/classes/services.NotificationService#registerattachmentgenerator) method,\nyou have access to it here. You can use the " + }, + { + "kind": "code", + "text": "`attachmentGenerator`" + }, + { + "kind": "text", + "text": " to generate on-demand invoices or other documents. The default value of this parameter is " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1, + "name": "ReturnedData", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 7, + "name": "INotificationService.sendNotification" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 6, + "name": "INotificationService.sendNotification" + } + }, + { + "id": 66, + "name": "resendNotification", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 67, + "name": "resendNotification", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to resend notifications, which is typically triggered by the\n[Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The resend details." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass EmailSenderService extends AbstractNotificationService {\n // ...\n async resendNotification(\n notification: any,\n config: any,\n attachmentGenerator: unknown\n ): Promise<{\n to: string;\n status: string;\n data: Record;\n }> {\n // check if the receiver should be changed\n const to: string = config.to || notification.to\n\n // TODO resend the notification using the same data\n // that is saved under notification.data\n\n console.log(\"Notification resent\")\n return {\n to,\n status: \"done\",\n data: notification.data, // make changes to the data\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 68, + "name": "notification", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The original [Notification record](https://docs.medusajs.com/references/entities/classes/Notification) that was created after you sent the\nnotification with " + }, + { + "kind": "code", + "text": "`sendNotification`" + }, + { + "kind": "text", + "text": ". It includes the " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " attributes which are populated originally using the " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`data`" + }, + { + "kind": "text", + "text": " properties of\nthe object you return in " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "sendNotification", + "target": 6, + "tsLinkText": "" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 69, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The new configuration used to resend the notification. The [Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend),\nallows you to pass a new " + }, + { + "kind": "code", + "text": "`to`" + }, + { + "kind": "text", + "text": " field. If specified, it will be available in this config object." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 70, + "name": "attachmentGenerator", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "f you’ve previously register an attachment generator to the " + }, + { + "kind": "code", + "text": "`NotificationService`" + }, + { + "kind": "text", + "text": " using the\n[" + }, + { + "kind": "code", + "text": "`registerAttachmentGenerator`" + }, + { + "kind": "text", + "text": "](https://docs.medusajs.com/references/services/classes/services.NotificationService#registerattachmentgenerator) method,\nyou have access to it here. You can use the " + }, + { + "kind": "code", + "text": "`attachmentGenerator`" + }, + { + "kind": "text", + "text": " to generate on-demand invoices or other documents. The default value of this parameter is " + }, + { + "kind": "code", + "text": "`null`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": 1, + "name": "ReturnedData", + "package": "@medusajs/medusa" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 12, + "name": "INotificationService.resendNotification" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 11, + "name": "INotificationService.resendNotification" + } + }, + { + "id": 71, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.manager_" + }, + "implementationOf": { + "type": "reference", + "target": 16, + "name": "INotificationService.manager_" + } + }, + { + "id": 72, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.transactionManager_" + }, + "implementationOf": { + "type": "reference", + "target": 17, + "name": "INotificationService.transactionManager_" + } + }, + { + "id": 75, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__container__" + }, + "implementationOf": { + "type": "reference", + "target": 20, + "name": "INotificationService.__container__" + } + }, + { + "id": 76, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__configModule__" + }, + "implementationOf": { + "type": "reference", + "target": 21, + "name": "INotificationService.__configModule__" + } + }, + { + "id": 77, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__moduleDeclaration__" + }, + "implementationOf": { + "type": "reference", + "target": 22, + "name": "INotificationService.__moduleDeclaration__" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 53 + ] + }, + { + "title": "Properties", + "children": [ + 49, + 59, + 60, + 71, + 72, + 75, + 76, + 77 + ] + }, + { + "title": "Methods", + "children": [ + 61, + 66 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService" + }, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 5, + "name": "INotificationService", + "package": "@medusajs/medusa" + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "children": [ + 47 + ] + }, + { + "title": "Interfaces", + "children": [ + 1, + 5 + ] + } + ], + "packageName": "@medusajs/medusa", + "symbolIdMap": { + "0": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "" + }, + "1": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "ReturnedData" + }, + "2": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "__type.to" + }, + "3": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "__type.status" + }, + "4": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "__type.data" + }, + "5": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "INotificationService" + }, + "6": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "INotificationService.sendNotification" + }, + "7": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "INotificationService.sendNotification" + }, + "8": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "event" + }, + "9": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "data" + }, + "10": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "attachmentGenerator" + }, + "11": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "INotificationService.resendNotification" + }, + "12": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "INotificationService.resendNotification" + }, + "13": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "notification" + }, + "14": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "config" + }, + "15": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "attachmentGenerator" + }, + "16": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.manager_" + }, + "17": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.transactionManager_" + }, + "18": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "19": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "20": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__container__" + }, + "21": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__configModule__" + }, + "22": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + }, + "23": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "24": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "25": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "26": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "27": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "28": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "err" + }, + "29": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "30": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type.code" + }, + "31": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "32": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "33": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TResult" + }, + "34": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TError" + }, + "35": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "work" + }, + "36": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "37": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "38": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "39": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "isolationOrErrorHandler" + }, + "40": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "41": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "42": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "43": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "maybeErrorHandlerOrDontFail" + }, + "44": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "45": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "46": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "47": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService" + }, + "49": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.identifier" + }, + "53": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.__constructor" + }, + "54": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService" + }, + "55": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "container" + }, + "56": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "config" + }, + "59": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.container" + }, + "60": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.config" + }, + "61": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.sendNotification" + }, + "62": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.sendNotification" + }, + "63": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "event" + }, + "64": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "data" + }, + "65": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "attachmentGenerator" + }, + "66": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.resendNotification" + }, + "67": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "AbstractNotificationService.resendNotification" + }, + "68": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "notification" + }, + "69": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "config" + }, + "70": { + "sourceFileName": "../../../packages/medusa/src/interfaces/notification-service.ts", + "qualifiedName": "attachmentGenerator" + }, + "71": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.manager_" + }, + "72": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.transactionManager_" + }, + "73": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "74": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "75": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__container__" + }, + "76": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__configModule__" + }, + "77": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + }, + "78": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "79": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "80": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "81": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "82": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "83": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "err" + }, + "84": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "85": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type.code" + }, + "86": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "87": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "88": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TResult" + }, + "89": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TError" + }, + "90": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "work" + }, + "91": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "92": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "93": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "94": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "isolationOrErrorHandler" + }, + "95": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "96": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "97": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "98": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "maybeErrorHandlerOrDontFail" + }, + "99": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "100": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "101": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + } + } +} \ No newline at end of file diff --git a/docs-util/typedoc-json-output/price-selection.json b/docs-util/typedoc-json-output/price-selection.json new file mode 100644 index 0000000000..e052d19c24 --- /dev/null +++ b/docs-util/typedoc-json-output/price-selection.json @@ -0,0 +1,2008 @@ +{ + "id": 0, + "name": "price-selection", + "variant": "project", + "kind": 1, + "flags": {}, + "children": [ + { + "id": 15, + "name": "AbstractPriceSelectionStrategy", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 20, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 21, + "name": "new AbstractPriceSelectionStrategy", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your price-selection strategy to access the different services in Medusa through dependency injection." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport {\n AbstractPriceSelectionStrategy,\n CustomerService,\n} from \"@medusajs/medusa\"\ntype InjectedDependencies = {\n customerService: CustomerService\n}\n\nclass MyStrategy extends\n AbstractPriceSelectionStrategy {\n\n protected customerService_: CustomerService\n\n constructor(container: InjectedDependencies) {\n super(container)\n this.customerService_ = container.customerService\n }\n\n // ...\n}\n\nexport default MyStrategy\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 22, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "MedusaContainer" + }, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 23, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this price-selection strategy is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 15, + "name": "AbstractPriceSelectionStrategy", + "package": "@medusajs/medusa" + }, + "overwrites": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 42, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 41, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 43, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 25, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this price-selection strategy is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 24, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "MedusaContainer" + }, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 37, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 38, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 26, + "name": "calculateVariantPrice", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 27, + "name": "calculateVariantPrice", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves one or more product variants' prices. It's used when retrieving product variants or their associated line items.\nIt's also used when retrieving other entities that product variants and line items belong to, such as products and carts respectively." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A map, each key is an ID of a variant, and its value is an object holding the price selection result." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, here's a snippet of how the price selection strategy is implemented in the Medusa backend:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport {\n AbstractPriceSelectionStrategy,\n CustomerService,\n PriceSelectionContext,\n PriceSelectionResult,\n} from \"@medusajs/medusa\"\n\ntype InjectedDependencies = {\n customerService: CustomerService\n}\n\nexport default class MyStrategy extends\n AbstractPriceSelectionStrategy {\n\n async calculateVariantPrice(\n data: {\n variantId: string\n quantity?: number\n }[],\n context: PriceSelectionContext\n ): Promise> {\n const dataMap = new Map(data.map((d) => [d.variantId, d]))\n\n const cacheKeysMap = new Map(\n data.map(({ variantId, quantity }) => [\n variantId,\n this.getCacheKey(variantId, { ...context, quantity }),\n ])\n )\n\n const nonCachedData: {\n variantId: string\n quantity?: number\n }[] = []\n\n const variantPricesMap = new Map()\n\n if (!context.ignore_cache) {\n const cacheHits = await promiseAll(\n [...cacheKeysMap].map(async ([, cacheKey]) => {\n return await this.cacheService_.get(cacheKey)\n })\n )\n\n if (!cacheHits.length) {\n nonCachedData.push(...dataMap.values())\n }\n\n for (const [index, cacheHit] of cacheHits.entries()) {\n const variantId = data[index].variantId\n if (cacheHit) {\n variantPricesMap.set(variantId, cacheHit)\n continue\n }\n\n nonCachedData.push(dataMap.get(variantId)!)\n }\n } else {\n nonCachedData.push(...dataMap.values())\n }\n\n let results: Map = new Map()\n\n if (\n this.featureFlagRouter_.isFeatureEnabled(\n TaxInclusivePricingFeatureFlag.key\n )\n ) {\n results = await this.calculateVariantPrice_new(nonCachedData, context)\n } else {\n results = await this.calculateVariantPrice_old(nonCachedData, context)\n }\n\n await promiseAll(\n [...results].map(async ([variantId, prices]) => {\n variantPricesMap.set(variantId, prices)\n if (!context.ignore_cache) {\n await this.cacheService_.set(cacheKeysMap.get(variantId)!, prices)\n }\n })\n )\n\n return variantPricesMap\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 28, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The necessary data to perform the price selection for each variant ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 29, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 32, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 30, + "name": "variantId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 32, + 30 + ] + } + ] + } + } + } + }, + { + "id": 33, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context of the price selection." + } + ] + }, + "type": { + "type": "reference", + "target": 68, + "name": "PriceSelectionContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es2015.collection.d.ts", + "qualifiedName": "Map" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 83, + "name": "PriceSelectionResult", + "package": "@medusajs/medusa" + } + ], + "name": "Map", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3, + "name": "IPriceSelectionStrategy.calculateVariantPrice" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2, + "name": "IPriceSelectionStrategy.calculateVariantPrice" + } + }, + { + "id": 34, + "name": "onVariantsPricesUpdate", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true + }, + "signatures": [ + { + "id": 35, + "name": "onVariantsPricesUpdate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is called when prices of product variants have changed.\nYou can use it to invalidate prices stored in the cache." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Resolves after any necessary actions are performed." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, this is how this method is implemented in the Medusa backend's default\nprice selection strategy:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport {\n AbstractPriceSelectionStrategy,\n CustomerService,\n} from \"@medusajs/medusa\"\nimport { promiseAll } from \"@medusajs/utils\"\n\ntype InjectedDependencies = {\n customerService: CustomerService\n}\n\nexport default class MyStrategy extends\n AbstractPriceSelectionStrategy {\n\n public async onVariantsPricesUpdate(variantIds: string[]): Promise {\n await promiseAll(\n variantIds.map(\n async (id: string) => await this.cacheService_.invalidate(`ps:${id}:*`)\n )\n )\n }\n\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::note\n\nLearn more about the cache service in [this documentation](https://docs.medusajs.com/development/cache/overview).\n\n:::" + } + ] + } + ] + }, + "parameters": [ + { + "id": 36, + "name": "variantIds", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the updated variants." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 10, + "name": "IPriceSelectionStrategy.onVariantsPricesUpdate" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 9, + "name": "IPriceSelectionStrategy.onVariantsPricesUpdate" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 20 + ] + }, + { + "title": "Properties", + "children": [ + 42, + 41, + 43, + 25, + 24, + 37, + 38 + ] + }, + { + "title": "Methods", + "children": [ + 26, + 34 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService" + }, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 1, + "name": "IPriceSelectionStrategy", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 1, + "name": "IPriceSelectionStrategy", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\nThe price selection strategy retrieves the best price for a product variant for a specific context such as selected region, taxes applied,\nthe quantity in cart, and more.\n\nMedusa provides a default price selection strategy, but you can override it. A price selecion strategy is a TypeScript or JavaScript file in the " + }, + { + "kind": "code", + "text": "`src/strategies`" + }, + { + "kind": "text", + "text": " directory of your Medusa backend project. It exports a class that extends the " + }, + { + "kind": "code", + "text": "`AbstractPriceSelectionStrategy`" + }, + { + "kind": "text", + "text": " class.\n\nFor example:\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/strategies/price.ts\"\nimport {\n AbstractPriceSelectionStrategy,\n PriceSelectionContext,\n PriceSelectionResult,\n} from \"@medusajs/medusa\"\n\nexport default class MyStrategy extends\n AbstractPriceSelectionStrategy {\n\n async calculateVariantPrice(\n data: {\n variantId: string;\n quantity?: number\n }[],\n context: PriceSelectionContext\n ): Promise> {\n throw new Error(\"Method not implemented.\")\n }\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---" + } + ] + }, + "children": [ + { + "id": 2, + "name": "calculateVariantPrice", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3, + "name": "calculateVariantPrice", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method retrieves one or more product variants' prices. It's used when retrieving product variants or their associated line items.\nIt's also used when retrieving other entities that product variants and line items belong to, such as products and carts respectively." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "A map, each key is an ID of a variant, and its value is an object holding the price selection result." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, here's a snippet of how the price selection strategy is implemented in the Medusa backend:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport {\n AbstractPriceSelectionStrategy,\n CustomerService,\n PriceSelectionContext,\n PriceSelectionResult,\n} from \"@medusajs/medusa\"\n\ntype InjectedDependencies = {\n customerService: CustomerService\n}\n\nexport default class MyStrategy extends\n AbstractPriceSelectionStrategy {\n\n async calculateVariantPrice(\n data: {\n variantId: string\n quantity?: number\n }[],\n context: PriceSelectionContext\n ): Promise> {\n const dataMap = new Map(data.map((d) => [d.variantId, d]))\n\n const cacheKeysMap = new Map(\n data.map(({ variantId, quantity }) => [\n variantId,\n this.getCacheKey(variantId, { ...context, quantity }),\n ])\n )\n\n const nonCachedData: {\n variantId: string\n quantity?: number\n }[] = []\n\n const variantPricesMap = new Map()\n\n if (!context.ignore_cache) {\n const cacheHits = await promiseAll(\n [...cacheKeysMap].map(async ([, cacheKey]) => {\n return await this.cacheService_.get(cacheKey)\n })\n )\n\n if (!cacheHits.length) {\n nonCachedData.push(...dataMap.values())\n }\n\n for (const [index, cacheHit] of cacheHits.entries()) {\n const variantId = data[index].variantId\n if (cacheHit) {\n variantPricesMap.set(variantId, cacheHit)\n continue\n }\n\n nonCachedData.push(dataMap.get(variantId)!)\n }\n } else {\n nonCachedData.push(...dataMap.values())\n }\n\n let results: Map = new Map()\n\n if (\n this.featureFlagRouter_.isFeatureEnabled(\n TaxInclusivePricingFeatureFlag.key\n )\n ) {\n results = await this.calculateVariantPrice_new(nonCachedData, context)\n } else {\n results = await this.calculateVariantPrice_old(nonCachedData, context)\n }\n\n await promiseAll(\n [...results].map(async ([variantId, prices]) => {\n variantPricesMap.set(variantId, prices)\n if (!context.ignore_cache) {\n await this.cacheService_.set(cacheKeysMap.get(variantId)!, prices)\n }\n })\n )\n\n return variantPricesMap\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 4, + "name": "data", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The necessary data to perform the price selection for each variant ID." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reflection", + "declaration": { + "id": 5, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 7, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The variant's quantity in the cart, if available." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 6, + "name": "variantId", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the variant to retrieve its prices." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 7, + 6 + ] + } + ] + } + } + } + }, + { + "id": 8, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context of the price selection." + } + ] + }, + "type": { + "type": "reference", + "target": 68, + "name": "PriceSelectionContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es2015.collection.d.ts", + "qualifiedName": "Map" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "reference", + "target": 83, + "name": "PriceSelectionResult", + "package": "@medusajs/medusa" + } + ], + "name": "Map", + "package": "typescript" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 9, + "name": "onVariantsPricesUpdate", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 10, + "name": "onVariantsPricesUpdate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is called when prices of product variants have changed.\nYou can use it to invalidate prices stored in the cache." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "Resolves after any necessary actions are performed." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "For example, this is how this method is implemented in the Medusa backend's default\nprice selection strategy:\n\n" + }, + { + "kind": "code", + "text": "```ts\nimport {\n AbstractPriceSelectionStrategy,\n CustomerService,\n} from \"@medusajs/medusa\"\nimport { promiseAll } from \"@medusajs/utils\"\n\ntype InjectedDependencies = {\n customerService: CustomerService\n}\n\nexport default class MyStrategy extends\n AbstractPriceSelectionStrategy {\n\n public async onVariantsPricesUpdate(variantIds: string[]): Promise {\n await promiseAll(\n variantIds.map(\n async (id: string) => await this.cacheService_.invalidate(`ps:${id}:*`)\n )\n )\n }\n\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n:::note\n\nLearn more about the cache service in [this documentation](https://docs.medusajs.com/development/cache/overview).\n\n:::" + } + ] + } + ] + }, + "parameters": [ + { + "id": 11, + "name": "variantIds", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The IDs of the updated variants." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "intrinsic", + "name": "string" + } + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "void" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + }, + { + "id": 12, + "name": "withTransaction", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 13, + "name": "withTransaction", + "variant": "signature", + "kind": 4096, + "flags": {}, + "parameters": [ + { + "id": 14, + "name": "transactionManager", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + } + ], + "type": { + "type": "intrinsic", + "name": "this" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "ITransactionBaseService.withTransaction" + } + } + ], + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "ITransactionBaseService.withTransaction" + } + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 2, + 9, + 12 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "ITransactionBaseService" + }, + "name": "ITransactionBaseService", + "package": "@medusajs/types" + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 15, + "name": "AbstractPriceSelectionStrategy" + } + ] + }, + { + "id": 68, + "name": "PriceSelectionContext", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The context of the price selection." + } + ] + }, + "children": [ + { + "id": 69, + "name": "cart_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's ID. This is used when the prices are being retrieved for the variant of a line item,\nas it is used to determine the current region and currency code of the context." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 73, + "name": "currency_code", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The currency code the customer is using." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 70, + "name": "customer_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the customer viewing the variant." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 76, + "name": "ignore_cache", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether to calculate the prices even if the value of an earlier price calculation\nis available in the cache." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 74, + "name": "include_discount_prices", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the price list's prices should be retrieved or not." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 72, + "name": "quantity", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The quantity of the item in the cart. This is used to filter out price lists that have\n" + }, + { + "kind": "code", + "text": "`min_quantity`" + }, + { + "kind": "text", + "text": " or " + }, + { + "kind": "code", + "text": "`max_quantity`" + }, + { + "kind": "text", + "text": " conditions set." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "number" + } + }, + { + "id": 71, + "name": "region_id", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The region's ID." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 75, + "name": "tax_rates", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax rates to be applied. This is only used for\n[Tax-Inclusive Pricing](https://docs.medusajs.com/modules/taxes/inclusive-pricing)." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", + "qualifiedName": "TaxServiceRate" + }, + "name": "TaxServiceRate", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 69, + 73, + 70, + 76, + 74, + 72, + 71, + 75 + ] + } + ] + }, + { + "id": 83, + "name": "PriceSelectionResult", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The price selection result of a variant." + } + ] + }, + "children": [ + { + "id": 86, + "name": "calculatedPrice", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The lowest price among the prices of the product variant retrieved using the context object." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 87, + "name": "calculatedPriceIncludesTax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the calculated price includes taxes or not.\nThis is only available for [Tax-Inclusive Pricing](https://docs.medusajs.com/modules/taxes/inclusive-pricing)." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + }, + { + "id": 88, + "name": "calculatedPriceType", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of price applied in " + }, + { + "kind": "code", + "text": "`calculatedPrice`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "reference", + "target": 82, + "name": "PriceType", + "package": "@medusajs/medusa" + } + }, + { + "id": 84, + "name": "originalPrice", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The original price of the variant which depends on the selected region or currency code in the context object.\nIf both region ID and currency code are available in the context object, the region has higher precedence." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + }, + { + "id": 85, + "name": "originalPriceIncludesTax", + "variant": "declaration", + "kind": 1024, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the original price includes taxes or not. This is only available\nfor [Tax-Inclusive Pricing](https://docs.medusajs.com/modules/taxes/inclusive-pricing)." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "boolean" + } + ] + } + }, + { + "id": 89, + "name": "prices", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "All possible prices of the variant that are retrieved using the " + }, + { + "kind": "code", + "text": "`context`" + }, + { + "kind": "text", + "text": " object.\nIt can include its original price and its price lists if there are any." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/money-amount.ts", + "qualifiedName": "MoneyAmount" + }, + "name": "MoneyAmount", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 86, + 87, + 88, + 84, + 85, + 89 + ] + } + ] + }, + { + "id": 82, + "name": "PriceType", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "DefaultPriceType" + }, + "name": "DefaultPriceType", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "PriceListType" + }, + "name": "PriceListType", + "package": "@medusajs/medusa" + } + ] + } + }, + { + "id": 77, + "name": "PriceType", + "variant": "declaration", + "kind": 32, + "flags": {}, + "type": { + "type": "reflection", + "declaration": { + "id": 78, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 81, + "name": "DEFAULT", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "DefaultPriceType.DEFAULT" + }, + "name": "DEFAULT", + "package": "@medusajs/medusa", + "qualifiedName": "DefaultPriceType.DEFAULT" + }, + "defaultValue": "\"default\"" + }, + { + "id": 80, + "name": "OVERRIDE", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "PriceListType.OVERRIDE" + }, + "name": "OVERRIDE", + "package": "@medusajs/medusa", + "qualifiedName": "PriceListType.OVERRIDE" + }, + "defaultValue": "\"override\"" + }, + { + "id": 79, + "name": "SALE", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "PriceListType.SALE" + }, + "name": "SALE", + "package": "@medusajs/medusa", + "qualifiedName": "PriceListType.SALE" + }, + "defaultValue": "\"sale\"" + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 81, + 80, + 79 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Classes", + "children": [ + 15 + ] + }, + { + "title": "Interfaces", + "children": [ + 1, + 68, + 83 + ] + }, + { + "title": "Type Aliases", + "children": [ + 82 + ] + }, + { + "title": "Variables", + "children": [ + 77 + ] + } + ], + "packageName": "@medusajs/medusa", + "symbolIdMap": { + "0": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "" + }, + "1": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "IPriceSelectionStrategy" + }, + "2": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "IPriceSelectionStrategy.calculateVariantPrice" + }, + "3": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "IPriceSelectionStrategy.calculateVariantPrice" + }, + "4": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "data" + }, + "5": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type" + }, + "6": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.variantId" + }, + "7": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.quantity" + }, + "8": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "context" + }, + "9": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "IPriceSelectionStrategy.onVariantsPricesUpdate" + }, + "10": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "IPriceSelectionStrategy.onVariantsPricesUpdate" + }, + "11": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "variantIds" + }, + "12": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "ITransactionBaseService.withTransaction" + }, + "13": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "ITransactionBaseService.withTransaction" + }, + "14": { + "sourceFileName": "../../../packages/types/src/transaction-base/transaction-base.ts", + "qualifiedName": "transactionManager" + }, + "15": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy" + }, + "20": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.__constructor" + }, + "21": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy" + }, + "22": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "container" + }, + "23": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "config" + }, + "24": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.container" + }, + "25": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.config" + }, + "26": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.calculateVariantPrice" + }, + "27": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.calculateVariantPrice" + }, + "28": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "data" + }, + "29": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type" + }, + "30": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.variantId" + }, + "32": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.quantity" + }, + "33": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "context" + }, + "34": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.onVariantsPricesUpdate" + }, + "35": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "AbstractPriceSelectionStrategy.onVariantsPricesUpdate" + }, + "36": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "variantIds" + }, + "37": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.manager_" + }, + "38": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.transactionManager_" + }, + "39": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "40": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "41": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__container__" + }, + "42": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__configModule__" + }, + "43": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + }, + "44": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "45": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "46": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "47": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "48": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "49": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "err" + }, + "50": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "51": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type.code" + }, + "52": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "53": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "54": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TResult" + }, + "55": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TError" + }, + "56": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "work" + }, + "57": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "58": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "59": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "60": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "isolationOrErrorHandler" + }, + "61": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "62": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "63": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "64": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "maybeErrorHandlerOrDontFail" + }, + "65": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "66": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "67": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "68": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "PriceSelectionContext" + }, + "69": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.cart_id" + }, + "70": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.customer_id" + }, + "71": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.region_id" + }, + "72": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.quantity" + }, + "73": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.currency_code" + }, + "74": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.include_discount_prices" + }, + "75": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.tax_rates" + }, + "76": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.ignore_cache" + }, + "77": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "PriceType" + }, + "78": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__object" + }, + "79": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "SALE" + }, + "80": { + "sourceFileName": "../../../packages/medusa/src/types/price-list.ts", + "qualifiedName": "OVERRIDE" + }, + "81": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "DEFAULT" + }, + "82": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "PriceType" + }, + "83": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "PriceSelectionResult" + }, + "84": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.originalPrice" + }, + "85": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.originalPriceIncludesTax" + }, + "86": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.calculatedPrice" + }, + "87": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.calculatedPriceIncludesTax" + }, + "88": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.calculatedPriceType" + }, + "89": { + "sourceFileName": "../../../packages/medusa/src/interfaces/price-selection-strategy.ts", + "qualifiedName": "__type.prices" + } + } +} \ No newline at end of file diff --git a/docs-util/typedoc-json-output/search.json b/docs-util/typedoc-json-output/search.json new file mode 100644 index 0000000000..3e86d10816 --- /dev/null +++ b/docs-util/typedoc-json-output/search.json @@ -0,0 +1,1459 @@ +{ + "id": 0, + "name": "search", + "variant": "project", + "kind": 1, + "flags": {}, + "children": [ + { + "id": 1, + "name": "AbstractSearchService", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\nA search service class is in a TypeScript or JavaScript file created in the " + }, + { + "kind": "code", + "text": "`src/services`" + }, + { + "kind": "text", + "text": " directory. The class must extend the " + }, + { + "kind": "code", + "text": "`AbstractSearchService`" + }, + { + "kind": "text", + "text": " class imported\n from the " + }, + { + "kind": "code", + "text": "`@medusajs/utils`" + }, + { + "kind": "text", + "text": " package.\n\nBased on services’ naming conventions, the file’s name should be the slug version of the search service’s name without " + }, + { + "kind": "code", + "text": "`service`" + }, + { + "kind": "text", + "text": ", and the class’s name should be the \npascal case of the search service’s name following by " + }, + { + "kind": "code", + "text": "`Service`" + }, + { + "kind": "text", + "text": ".\n\nFor example, create the " + }, + { + "kind": "code", + "text": "`MySearchService`" + }, + { + "kind": "text", + "text": " class in the file " + }, + { + "kind": "code", + "text": "`src/services/my-search.ts`" + }, + { + "kind": "text", + "text": ":\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/services/my-search.ts\"\nimport { AbstractSearchService } from \"@medusajs/utils\"\n\nclass MySearchService extends AbstractSearchService {\n isDefault = false\n \n createIndex(indexName: string, options: Record) {\n throw new Error(\"Method not implemented.\")\n }\n getIndex(indexName: string) {\n throw new Error(\"Method not implemented.\")\n }\n addDocuments(\n indexName: string,\n documents: Record[],\n type: string\n ) {\n throw new Error(\"Method not implemented.\")\n }\n replaceDocuments(\n indexName: string,\n documents: Record[],\n type: string\n ) {\n throw new Error(\"Method not implemented.\")\n }\n deleteDocument(\n indexName: string,\n document_id: string | number\n ) {\n throw new Error(\"Method not implemented.\")\n }\n deleteAllDocuments(indexName: string) {\n throw new Error(\"Method not implemented.\")\n }\n search(\n indexName: string,\n query: string, \n options: Record\n ) {\n return {\n message: \"test\",\n }\n }\n updateSettings(\n indexName: string, \n settings: Record\n ) {\n throw new Error(\"Method not implemented.\")\n }\n\n}\n\nexport default MySearchService\n```" + }, + { + "kind": "text", + "text": "\n\n---\n\n## Notes About Class Methods\n\nAlthough there are several helper methods in this class, the main methods used by the Medusa backend are " + }, + { + "kind": "code", + "text": "`addDocuments`" + }, + { + "kind": "text", + "text": ", " + }, + { + "kind": "code", + "text": "`deleteDocument`" + }, + { + "kind": "text", + "text": ", and " + }, + { + "kind": "code", + "text": "`search`" + }, + { + "kind": "text", + "text": ". \nThe rest of the methods are provided in case you need them for custom use cases.\n\n---" + } + ] + }, + "children": [ + { + "id": 10, + "name": "isDefault", + "variant": "declaration", + "kind": 1024, + "flags": { + "isAbstract": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This property is used to pinpoint the default search service defined in the Medusa core. For custom search services, the " + }, + { + "kind": "code", + "text": "`isDefault`" + }, + { + "kind": "text", + "text": " property must be " + }, + { + "kind": "code", + "text": "`false`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 11, + "name": "options_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If your search service is created in a plugin, the plugin's options will be available in this property." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 6, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 7, + "name": "new AbstractSearchService", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your search service to access the different services in Medusa through dependency injection.\n\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs,\nyou can initialize it in the constructor and use it in other methods in the service.\n\nAdditionally, if you’re creating your search service as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin,\nyou can access them in the constructor. The default constructor already sets the value of the class proeprty " + }, + { + "kind": "code", + "text": "`options_`" + }, + { + "kind": "text", + "text": " to the passed options." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport { ProductService } from \"@medusajs/medusa\"\n\ntype InjectedDependencies = {\n productService: ProductService\n}\n\nclass MySearchService extends AbstractSearchService {\n // ...\n protected readonly productService_: ProductService\n\n constructor({ productService }: InjectedDependencies) {\n // @ts-expect-error prefer-rest-params\n super(...arguments)\n this.productService_ = productService\n\n // you can also initialize a client that\n // communicates with a third-party service.\n this.client = new Client(options)\n }\n\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 8, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "any" + } + }, + { + "id": 9, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this search service is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "any" + } + } + ], + "type": { + "type": "reference", + "target": 1, + "name": "AbstractSearchService", + "package": "@medusajs/utils" + } + } + ] + }, + { + "id": 14, + "name": "createIndex", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 15, + "name": "createIndex", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to create an index in the search engine." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "No required format of returned data, as it depends on your custom implementation." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "An example implementation, assuming " + }, + { + "kind": "code", + "text": "`client`" + }, + { + "kind": "text", + "text": " would interact with a third-party service:\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/services/my-search.ts\"\nclass MySearchService extends AbstractSearchService {\n // ...\n createIndex(indexName: string, options: Record) {\n return this.client_.initIndex(indexName)\n }\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\nAnother example of how the [MeiliSearch plugin](https://docs.medusajs.com/plugins/search/meilisearch) uses the\n" + }, + { + "kind": "code", + "text": "`options`" + }, + { + "kind": "text", + "text": " parameter:\n\n" + }, + { + "kind": "code", + "text": "```ts\nclass MeiliSearchService extends AbstractSearchService {\n // ...\n async createIndex(\n indexName: string,\n options: Record = { primaryKey: \"id\" }\n ) {\n return await this.client_.createIndex(indexName, options)\n }\n // ...\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 16, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the index to create." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 17, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Any options that may be relevant to your search service. This parameter doesn't have \nany defined format as it depends on your custom implementation." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.createIndex" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.createIndex" + } + }, + { + "id": 18, + "name": "getIndex", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 19, + "name": "getIndex", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to retrieve an index’s results from the search engine." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "No required format of returned data, as it depends on your custom implementation." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MySearchService extends AbstractSearchService {\n // ...\n\n getIndex(indexName: string) {\n return this.client_.getIndex(indexName)\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 20, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the index" + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.getIndex" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.getIndex" + } + }, + { + "id": 21, + "name": "addDocuments", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 22, + "name": "addDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to add a document to an index in the search engine.\n\nWhen the Medusa backend loads, it triggers indexing for all products available in the Medusa backend, which uses this method to add or update documents.\nIt’s also used whenever a new product is added or a product is updated." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The response of saving the documents in the search engine, but there’s no required format of the response." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MySearchService extends AbstractSearchService {\n // ...\n\n async addDocuments(\n indexName: string,\n documents: Record[],\n type: string\n ) {\n return await this.client_\n .addDocuments(indexName, documents)\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 23, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the index to add the documents to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 24, + "name": "documents", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of documents to add. For example, an array of " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "entities!Product | products" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 25, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of documents being indexed. For example, " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.addDocuments" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.addDocuments" + } + }, + { + "id": 26, + "name": "replaceDocuments", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 27, + "name": "replaceDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to replace existing documents in the search engine of an index with new documents." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The response of replacing the documents in the search engine, but there’s no required format of the response." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MySearchService extends AbstractSearchService {\n // ...\n\n async replaceDocuments(\n indexName: string,\n documents: Record[],\n type: string\n ) {\n await this.client_\n .removeDocuments(indexName)\n return await this.client_\n .addDocuments(indexName, documents)\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 28, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the index that the documents belong to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 29, + "name": "documents", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The list of documents to index. For example, it can be an array of " + }, + { + "kind": "inline-tag", + "tag": "@link", + "text": "entities!Product | products" + }, + { + "kind": "text", + "text": ".\nBased on your search engine implementation, the documents should include an identification key that allows replacing the existing documents." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + }, + { + "id": 30, + "name": "type", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The type of documents being replaced. For example, " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.replaceDocuments" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.replaceDocuments" + } + }, + { + "id": 31, + "name": "deleteDocument", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 32, + "name": "deleteDocument", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to delete a document from an index.\n\nWhen a product is deleted in the Medusa backend, this method is used to delete the product from the search engine’s index." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The response of deleting the document in the search engine, but there’s no required format of the response." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MySearchService extends AbstractSearchService {\n // ...\n\n async deleteDocument(\n indexName: string,\n document_id: string | number\n ) {\n return await this.client_\n .deleteDocument(indexName, document_id)\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 33, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The name of the index that the document belongs to." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 34, + "name": "document_id", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The ID of the item indexed. For example, if the deleted item is a product, then this is\nthe ID of the product." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "number" + } + ] + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.deleteDocument" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.deleteDocument" + } + }, + { + "id": 35, + "name": "deleteAllDocuments", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 36, + "name": "deleteAllDocuments", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to delete all documents from an index." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The response of deleting the documents of that index in the search engine, but there’s no required format of the response." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MySearchService extends AbstractSearchService {\n // ...\n\n async deleteAllDocuments(indexName: string) {\n return await this.client_\n .deleteDocuments(indexName)\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 37, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The index's name." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.deleteAllDocuments" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.deleteAllDocuments" + } + }, + { + "id": 38, + "name": "search", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 39, + "name": "search", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to search through an index by a query.\n\nIn the Medusa backend, this method is used within the [Search Products API Route](https://docs.medusajs.com/api/store#products_postproductssearch) \nto retrieve the search results. The API route's response type is an array of items, though the item's format is not defined as it depends on the\ndata returned by this method." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The list of results. For example, an array of products." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MySearchService extends AbstractSearchService {\n // ...\n\n async search(\n indexName: string,\n query: string,\n options: Record\n ) {\n const hits = await this.client_\n .search(indexName, query)\n return {\n hits,\n }\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 40, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The index's name. In the case of the Search Products API Routes, its value is " + }, + { + "kind": "code", + "text": "`products`" + }, + { + "kind": "text", + "text": "." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 41, + "name": "query", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The search query to retrieve results for." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "literal", + "value": null + }, + { + "type": "intrinsic", + "name": "string" + } + ] + } + }, + { + "id": 42, + "name": "options", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Options that can configure the search process. The Search Products API route passes an object having the properties:\n\n- " + }, + { + "kind": "code", + "text": "`paginationOptions`" + }, + { + "kind": "text", + "text": ": An object having an " + }, + { + "kind": "code", + "text": "`offset`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`limit`" + }, + { + "kind": "text", + "text": " properties, which are passed in the API Route's body.\n- " + }, + { + "kind": "code", + "text": "`filter`" + }, + { + "kind": "text", + "text": ": Filters that are passed in the API Route's request body. Its format is unknown, so you can pass filters based on your search service.\n- " + }, + { + "kind": "code", + "text": "`additionalOptions`" + }, + { + "kind": "text", + "text": ": Any other parameters that may be passed in the request's body." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.search" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.search" + } + }, + { + "id": 43, + "name": "updateSettings", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 44, + "name": "updateSettings", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used to update the settings of an index within the search service. This is useful if you want to update the index settings when the plugin options change.\n\nFor example, in the Algolia plugin, a loader, which runs when the Medusa backend loads, is used to update the settings of indices based on the plugin options. \nThe loader uses this method to update the settings." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The response of updating the index in the search engine, but there’s no required format of the response." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nclass MySearchService extends AbstractSearchService {\n // ...\n\n async updateSettings(\n indexName: string,\n settings: Record\n ) {\n return await this.client_\n .updateSettings(indexName, settings)\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 45, + "name": "indexName", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The index's name to update its settings." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 46, + "name": "settings", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The settings to update. Its format depends on your use case." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "unknown" + } + } + ], + "type": { + "type": "intrinsic", + "name": "unknown" + }, + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.updateSettings" + } + } + ], + "implementationOf": { + "type": "reference", + "target": -1, + "name": "SearchTypes.ISearchService.updateSettings" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 6 + ] + }, + { + "title": "Properties", + "children": [ + 10, + 11 + ] + }, + { + "title": "Methods", + "children": [ + 14, + 18, + 21, + 26, + 31, + 35, + 38, + 43 + ] + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/search/interface.ts", + "qualifiedName": "ISearchService" + }, + "name": "ISearchService", + "package": "@medusajs/types" + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "children": [ + 1 + ] + } + ], + "packageName": "@medusajs/utils", + "symbolIdMap": { + "0": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "" + }, + "1": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService" + }, + "6": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.__constructor" + }, + "7": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService" + }, + "8": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "container" + }, + "9": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "options" + }, + "10": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.isDefault" + }, + "11": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.options_" + }, + "14": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.createIndex" + }, + "15": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.createIndex" + }, + "16": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "indexName" + }, + "17": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "options" + }, + "18": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.getIndex" + }, + "19": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.getIndex" + }, + "20": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "indexName" + }, + "21": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.addDocuments" + }, + "22": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.addDocuments" + }, + "23": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "indexName" + }, + "24": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "documents" + }, + "25": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "type" + }, + "26": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.replaceDocuments" + }, + "27": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.replaceDocuments" + }, + "28": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "indexName" + }, + "29": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "documents" + }, + "30": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "type" + }, + "31": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.deleteDocument" + }, + "32": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.deleteDocument" + }, + "33": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "indexName" + }, + "34": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "document_id" + }, + "35": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.deleteAllDocuments" + }, + "36": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.deleteAllDocuments" + }, + "37": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "indexName" + }, + "38": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.search" + }, + "39": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.search" + }, + "40": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "indexName" + }, + "41": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "query" + }, + "42": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "options" + }, + "43": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.updateSettings" + }, + "44": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "AbstractSearchService.updateSettings" + }, + "45": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "indexName" + }, + "46": { + "sourceFileName": "../../../packages/utils/src/search/abstract-service.ts", + "qualifiedName": "settings" + } + } +} \ No newline at end of file diff --git a/docs-util/typedoc-json-output/tax-calculation.json b/docs-util/typedoc-json-output/tax-calculation.json new file mode 100644 index 0000000000..9b9f465c22 --- /dev/null +++ b/docs-util/typedoc-json-output/tax-calculation.json @@ -0,0 +1,1028 @@ +{ + "id": 0, + "name": "tax-calculation", + "variant": "project", + "kind": 1, + "flags": {}, + "children": [ + { + "id": 1, + "name": "ITaxCalculationStrategy", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\nA tax calculation strategy is used to calculate taxes when calculating a cart's totals. The Medusa\nbackend provides a tax calculation strategy that handles calculating the taxes, taking into account the\ndefined tax rates and settings such as whether tax-inclusive pricing is enabled.\n\nYou can override the tax calculation strategy to implement different calculation logic or to\nintegrate a third-party service that handles the tax calculation. You can override it either\nin a Medusa backend setup or in a plugin.\n\nA tax calculation strategy should be defined in a TypeScript or JavaScript file created under the " + }, + { + "kind": "code", + "text": "`src/strategies`" + }, + { + "kind": "text", + "text": " directory.\nThe class must also implement the " + }, + { + "kind": "code", + "text": "`ITaxCalculationStrategy`" + }, + { + "kind": "text", + "text": " interface imported from the " + }, + { + "kind": "code", + "text": "`@medusajs/medusa`" + }, + { + "kind": "text", + "text": " package.\n\nFor example, you can create the file " + }, + { + "kind": "code", + "text": "`src/strategies/tax-calculation.ts`" + }, + { + "kind": "text", + "text": " with the following content:\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/strategies/tax-calculation.ts\"\nimport {\n ITaxCalculationStrategy,\n LineItem,\n LineItemTaxLine,\n ShippingMethodTaxLine,\n TaxCalculationContext,\n} from \"@medusajs/medusa\"\n\nclass TaxCalculationStrategy\n implements ITaxCalculationStrategy {\n\n async calculate(\n items: LineItem[],\n taxLines: (ShippingMethodTaxLine | LineItemTaxLine)[],\n calculationContext: TaxCalculationContext\n ): Promise {\n throw new Error(\"Method not implemented.\")\n }\n\n}\n\nexport default TaxCalculationStrategy\n```" + }, + { + "kind": "text", + "text": "\n\n---" + } + ] + }, + "children": [ + { + "id": 2, + "name": "calculate", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 3, + "name": "calculate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method calculates the tax amount for a given set of line items under applicable\ntax conditions and calculation contexts.\n\nThis method is used whenever taxes are calculated. If automatic tax calculation is disabled in a region,\nthen it's only triggered when taxes are calculated manually as explained in\n[this guide](https://docs.medusajs.com/modules/taxes/storefront/manual-calculation)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The calculated tax total" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "An example of the general implementation of this method in the Medusa backend's tax calculation strategy:\n\n" + }, + { + "kind": "code", + "text": "```ts\nasync calculate(\n items: LineItem[],\n taxLines: (ShippingMethodTaxLine | LineItemTaxLine)[],\n calculationContext: TaxCalculationContext\n): Promise {\n const lineItemsTaxLines = taxLines.filter(\n (tl) => \"item_id\" in tl\n ) as LineItemTaxLine[]\n const shippingMethodsTaxLines = taxLines.filter(\n (tl) => \"shipping_method_id\" in tl\n ) as ShippingMethodTaxLine[]\n\n const lineItemsTax = this.calculateLineItemsTax(\n items,\n lineItemsTaxLines,\n calculationContext\n )\n\n const shippingMethodsTax = this.calculateShippingMethodsTax(\n calculationContext.shipping_methods,\n shippingMethodsTaxLines\n )\n\n return Math.round(lineItemsTax + shippingMethodsTax)\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 4, + "name": "items", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line items to calculate the tax total for." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", + "qualifiedName": "LineItem" + }, + "name": "LineItem", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 5, + "name": "taxLines", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax lines used for the calculation" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item-tax-line.ts", + "qualifiedName": "LineItemTaxLine" + }, + "name": "LineItemTaxLine", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-method-tax-line.ts", + "qualifiedName": "ShippingMethodTaxLine" + }, + "name": "ShippingMethodTaxLine", + "package": "@medusajs/medusa" + } + ] + } + } + }, + { + "id": 6, + "name": "calculationContext", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Other details relevant for the calculation" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "TaxCalculationContext" + }, + "name": "TaxCalculationContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 2 + ] + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 7, + "name": "AbstractTaxCalculationStrategy" + } + ] + }, + { + "id": 7, + "name": "AbstractTaxCalculationStrategy", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 12, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 13, + "name": "new AbstractTaxCalculationStrategy", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your tax calculation strategy to access the different services in Medusa through dependency injection.\n\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the service.\nAdditionally, if you’re creating your tax calculation strategy as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, you can access it in the constructor." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\nimport {\n ITaxCalculationStrategy,\n LineItemService,\n} from \"@medusajs/medusa\"\n\ntype InjectedDependencies = {\n lineItemService: LineItemService\n}\n\nclass TaxCalculationStrategy\n implements ITaxCalculationStrategy {\n\n protected readonly lineItemService_: LineItemService\n\n constructor({ lineItemService }: InjectedDependencies) {\n this.lineItemService_ = lineItemService\n }\n\n // ...\n}\n\nexport default TaxCalculationStrategy\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 14, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "MedusaContainer" + }, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 15, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this tax calculation strategy is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 7, + "name": "AbstractTaxCalculationStrategy", + "package": "@medusajs/medusa" + }, + "overwrites": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 16, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/types/src/common/medusa-container.ts", + "qualifiedName": "MedusaContainer" + }, + "name": "MedusaContainer", + "package": "@medusajs/types" + } + }, + { + "id": 17, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this tax calculation strategy is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 18, + "name": "calculate", + "variant": "declaration", + "kind": 2048, + "flags": { + "isAbstract": true + }, + "signatures": [ + { + "id": 19, + "name": "calculate", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method calculates the tax amount for a given set of line items under applicable\ntax conditions and calculation contexts.\n\nThis method is used whenever taxes are calculated. If automatic tax calculation is disabled in a region,\nthen it's only triggered when taxes are calculated manually as explained in\n[this guide](https://docs.medusajs.com/modules/taxes/storefront/manual-calculation)." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The calculated tax total" + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "An example of the general implementation of this method in the Medusa backend's tax calculation strategy:\n\n" + }, + { + "kind": "code", + "text": "```ts\nasync calculate(\n items: LineItem[],\n taxLines: (ShippingMethodTaxLine | LineItemTaxLine)[],\n calculationContext: TaxCalculationContext\n): Promise {\n const lineItemsTaxLines = taxLines.filter(\n (tl) => \"item_id\" in tl\n ) as LineItemTaxLine[]\n const shippingMethodsTaxLines = taxLines.filter(\n (tl) => \"shipping_method_id\" in tl\n ) as ShippingMethodTaxLine[]\n\n const lineItemsTax = this.calculateLineItemsTax(\n items,\n lineItemsTaxLines,\n calculationContext\n )\n\n const shippingMethodsTax = this.calculateShippingMethodsTax(\n calculationContext.shipping_methods,\n shippingMethodsTaxLines\n )\n\n return Math.round(lineItemsTax + shippingMethodsTax)\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 20, + "name": "items", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line items to calculate the tax total for." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", + "qualifiedName": "LineItem" + }, + "name": "LineItem", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 21, + "name": "taxLines", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The tax lines used for the calculation" + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item-tax-line.ts", + "qualifiedName": "LineItemTaxLine" + }, + "name": "LineItemTaxLine", + "package": "@medusajs/medusa" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-method-tax-line.ts", + "qualifiedName": "ShippingMethodTaxLine" + }, + "name": "ShippingMethodTaxLine", + "package": "@medusajs/medusa" + } + ] + } + } + }, + { + "id": 22, + "name": "calculationContext", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Other details relevant for the calculation" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "TaxCalculationContext" + }, + "name": "TaxCalculationContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "number" + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 3, + "name": "ITaxCalculationStrategy.calculate" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 2, + "name": "ITaxCalculationStrategy.calculate" + } + }, + { + "id": 23, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 24, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 27, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 28, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 29, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__moduleDeclaration__" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 12 + ] + }, + { + "title": "Properties", + "children": [ + 16, + 17, + 23, + 24, + 27, + 28, + 29 + ] + }, + { + "title": "Methods", + "children": [ + 18 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService" + }, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 1, + "name": "ITaxCalculationStrategy", + "package": "@medusajs/medusa" + } + ] + } + ], + "groups": [ + { + "title": "Classes", + "children": [ + 7 + ] + }, + { + "title": "Interfaces", + "children": [ + 1 + ] + } + ], + "packageName": "@medusajs/medusa", + "symbolIdMap": { + "0": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "" + }, + "1": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "ITaxCalculationStrategy" + }, + "2": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "ITaxCalculationStrategy.calculate" + }, + "3": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "ITaxCalculationStrategy.calculate" + }, + "4": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "items" + }, + "5": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "taxLines" + }, + "6": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "calculationContext" + }, + "7": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy" + }, + "12": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy.__constructor" + }, + "13": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy" + }, + "14": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "container" + }, + "15": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "config" + }, + "16": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy.container" + }, + "17": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy.config" + }, + "18": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy.calculate" + }, + "19": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "AbstractTaxCalculationStrategy.calculate" + }, + "20": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "items" + }, + "21": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "taxLines" + }, + "22": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-calculation-strategy.ts", + "qualifiedName": "calculationContext" + }, + "23": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.manager_" + }, + "24": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.transactionManager_" + }, + "25": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "26": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "27": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__container__" + }, + "28": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__configModule__" + }, + "29": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + }, + "30": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "31": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "32": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "33": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "34": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "35": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "err" + }, + "36": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "37": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type.code" + }, + "38": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "39": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "40": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TResult" + }, + "41": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TError" + }, + "42": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "work" + }, + "43": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "44": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "45": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "46": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "isolationOrErrorHandler" + }, + "47": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "48": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "49": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "50": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "maybeErrorHandlerOrDontFail" + }, + "51": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "52": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "53": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + } + } +} \ No newline at end of file diff --git a/docs-util/typedoc-json-output/tax.json b/docs-util/typedoc-json-output/tax.json new file mode 100644 index 0000000000..2b5fd5370f --- /dev/null +++ b/docs-util/typedoc-json-output/tax.json @@ -0,0 +1,1559 @@ +{ + "id": 0, + "name": "tax", + "variant": "project", + "kind": 1, + "flags": {}, + "children": [ + { + "id": 23, + "name": "AbstractTaxService", + "variant": "declaration", + "kind": 128, + "flags": { + "isAbstract": true + }, + "children": [ + { + "id": 29, + "name": "constructor", + "variant": "declaration", + "kind": 512, + "flags": { + "isProtected": true + }, + "signatures": [ + { + "id": 30, + "name": "new AbstractTaxService", + "variant": "signature", + "kind": 16384, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "You can use the " + }, + { + "kind": "code", + "text": "`constructor`" + }, + { + "kind": "text", + "text": " of your tax provider to access the different services in Medusa through dependency injection.\n\nYou can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the service.\nAdditionally, if you’re creating your tax provider as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, you can access it in the constructor." + } + ], + "blockTags": [ + { + "tag": "@example", + "content": [ + { + "kind": "code", + "text": "```ts\n// ...\nimport { LineItemService } from \"@medusajs/medusa\"\n\ntype InjectedDependencies = {\n lineItemService: LineItemService\n}\n\nclass MyTaxService extends AbstractTaxService {\n protected readonly lineItemService_: LineItemService\n\n constructor({ lineItemService }: InjectedDependencies) {\n super(arguments[0])\n this.lineItemService_ = lineItemService\n\n // you can also initialize a client that\n // communicates with a third-party service.\n this.client = new Client(options)\n }\n\n // ...\n}\n\nexport default MyTaxService\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 31, + "name": "container", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", + "qualifiedName": "MedusaContainer" + }, + "name": "MedusaContainer", + "package": "medusa-core-utils" + } + }, + { + "id": 32, + "name": "config", + "variant": "param", + "kind": 32768, + "flags": { + "isOptional": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this tax provider is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + } + ], + "type": { + "type": "reference", + "target": 23, + "name": "AbstractTaxService", + "package": "@medusajs/medusa" + }, + "overwrites": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.constructor" + } + } + ], + "overwrites": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.constructor" + } + }, + { + "id": 47, + "name": "__configModule__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__configModule__" + } + }, + { + "id": 46, + "name": "__container__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "type": { + "type": "intrinsic", + "name": "any" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__container__" + } + }, + { + "id": 48, + "name": "__moduleDeclaration__", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.__moduleDeclaration__" + } + }, + { + "id": 34, + "name": "config", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isOptional": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "If this tax provider is created in a plugin, the plugin's options are passed in this parameter." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Record" + }, + "typeArguments": [ + { + "type": "intrinsic", + "name": "string" + }, + { + "type": "intrinsic", + "name": "unknown" + } + ], + "name": "Record", + "package": "typescript" + } + }, + { + "id": 33, + "name": "container", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isReadonly": true + }, + "comment": { + "summary": [ + { + "kind": "text", + "text": "An instance of " + }, + { + "kind": "code", + "text": "`MedusaContainer`" + }, + { + "kind": "text", + "text": " that allows you to access other resources, such as services, in your Medusa backend." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa-core-utils/dist/medusa-container.d.ts", + "qualifiedName": "MedusaContainer" + }, + "name": "MedusaContainer", + "package": "medusa-core-utils" + } + }, + { + "id": 42, + "name": "manager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.manager_" + } + }, + { + "id": 43, + "name": "transactionManager_", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true + }, + "type": { + "type": "union", + "types": [ + { + "type": "intrinsic", + "name": "undefined" + }, + { + "type": "reference", + "target": { + "sourceFileName": "../../../node_modules/typeorm/entity-manager/EntityManager.d.ts", + "qualifiedName": "EntityManager" + }, + "name": "EntityManager", + "package": "typeorm" + } + ] + }, + "inheritedFrom": { + "type": "reference", + "target": -1, + "name": "TransactionBaseService.transactionManager_" + } + }, + { + "id": 25, + "name": "identifier", + "variant": "declaration", + "kind": 1024, + "flags": { + "isProtected": true, + "isStatic": true + }, + "type": { + "type": "intrinsic", + "name": "string" + } + }, + { + "id": 37, + "name": "getTaxLines", + "variant": "declaration", + "kind": 2048, + "flags": { + "isPublic": true, + "isAbstract": true + }, + "signatures": [ + { + "id": 38, + "name": "getTaxLines", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used when retrieving the tax lines for line items and shipping methods.\nThis occurs during checkout or when calculating totals for orders, swaps, or returns." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The list of calculated line item and shipping method tax lines.\nIf an item in the array has the " + }, + { + "kind": "code", + "text": "`shipping_method_id`" + }, + { + "kind": "text", + "text": " property, then it's a shipping method tax line. Otherwise, if it has\nthe " + }, + { + "kind": "code", + "text": "`item_id`" + }, + { + "kind": "text", + "text": " property, then it's a line item tax line." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "An example of how this method is implemented in the " + }, + { + "kind": "code", + "text": "`system`" + }, + { + "kind": "text", + "text": " provider implemented in the Medusa backend:\n\n" + }, + { + "kind": "code", + "text": "```ts\n// ...\n\nclass SystemTaxService extends AbstractTaxService {\n // ...\n\n async getTaxLines(\n itemLines: ItemTaxCalculationLine[],\n shippingLines: ShippingTaxCalculationLine[],\n context: TaxCalculationContext\n ): Promise {\n let taxLines: ProviderTaxLine[] = itemLines.flatMap((l) => {\n return l.rates.map((r) => ({\n rate: r.rate || 0,\n name: r.name,\n code: r.code,\n item_id: l.item.id,\n }))\n })\n\n taxLines = taxLines.concat(\n shippingLines.flatMap((l) => {\n return l.rates.map((r) => ({\n rate: r.rate || 0,\n name: r.name,\n code: r.code,\n shipping_method_id: l.shipping_method.id,\n }))\n })\n )\n\n return taxLines\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 39, + "name": "itemLines", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item lines to calculate taxes for." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5, + "name": "ItemTaxCalculationLine", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 40, + "name": "shippingLines", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method lines to calculate taxes for." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1, + "name": "ShippingTaxCalculationLine", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 41, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Context relevant and useful for the taxes calculation." + } + ] + }, + "type": { + "type": "reference", + "target": 9, + "name": "TaxCalculationContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", + "qualifiedName": "ProviderTaxLine" + }, + "name": "ProviderTaxLine", + "package": "@medusajs/medusa" + } + } + ], + "name": "Promise", + "package": "typescript" + }, + "implementationOf": { + "type": "reference", + "target": 19, + "name": "ITaxService.getTaxLines" + } + } + ], + "implementationOf": { + "type": "reference", + "target": 18, + "name": "ITaxService.getTaxLines" + } + } + ], + "groups": [ + { + "title": "Constructors", + "children": [ + 29 + ] + }, + { + "title": "Properties", + "children": [ + 47, + 46, + 48, + 34, + 33, + 42, + 43, + 25 + ] + }, + { + "title": "Methods", + "children": [ + 37 + ] + } + ], + "extendedTypes": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService" + }, + "name": "TransactionBaseService", + "package": "@medusajs/medusa" + } + ], + "implementedTypes": [ + { + "type": "reference", + "target": 17, + "name": "ITaxService", + "package": "@medusajs/medusa" + } + ] + }, + { + "id": 17, + "name": "ITaxService", + "variant": "declaration", + "kind": 256, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "## Overview\n\nA tax provider is used to retrieve the tax lines in a cart. The Medusa backend provides a default " + }, + { + "kind": "code", + "text": "`system`" + }, + { + "kind": "text", + "text": " provider. You can create your own tax provider,\neither in a plugin or directly in your Medusa backend, then use it in any region.\n\nA tax provider class is defined in a TypeScript or JavaScript file under the " + }, + { + "kind": "code", + "text": "`src/services`" + }, + { + "kind": "text", + "text": " directory and the class must extend the\n" + }, + { + "kind": "code", + "text": "`AbstractTaxService`" + }, + { + "kind": "text", + "text": " class imported from " + }, + { + "kind": "code", + "text": "`@medusajs/medusa`" + }, + { + "kind": "text", + "text": ". The file's name is the tax provider's class name as a slug and without the word " + }, + { + "kind": "code", + "text": "`Service`" + }, + { + "kind": "text", + "text": ".\n\nFor example, you can create the file " + }, + { + "kind": "code", + "text": "`src/services/my-tax.ts`" + }, + { + "kind": "text", + "text": " with the following content:\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/services/my-tax.ts\"\nimport {\n AbstractTaxService,\n ItemTaxCalculationLine,\n ShippingTaxCalculationLine,\n TaxCalculationContext,\n} from \"@medusajs/medusa\"\nimport {\n ProviderTaxLine,\n} from \"@medusajs/medusa/dist/types/tax-service\"\n\nclass MyTaxService extends AbstractTaxService {\n async getTaxLines(\n itemLines: ItemTaxCalculationLine[],\n shippingLines: ShippingTaxCalculationLine[],\n context: TaxCalculationContext):\n Promise {\n throw new Error(\"Method not implemented.\")\n }\n}\n\nexport default MyTaxService\n```" + }, + { + "kind": "text", + "text": "\n\n---\n\n## Identifier Property\n\nThe " + }, + { + "kind": "code", + "text": "`TaxProvider`" + }, + { + "kind": "text", + "text": " entity has 2 properties: " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " and " + }, + { + "kind": "code", + "text": "`is_installed`" + }, + { + "kind": "text", + "text": ". The " + }, + { + "kind": "code", + "text": "`identifier`" + }, + { + "kind": "text", + "text": " property in the tax provider service is used when the tax provider is added to the database.\n\nThe value of this property is also used to reference the tax provider throughout Medusa. For example, it is used to [change the tax provider](https://docs.medusajs.com/modules/taxes/admin/manage-tax-settings#change-tax-provider-of-a-region) to a region.\n\n" + }, + { + "kind": "code", + "text": "```ts title=\"src/services/my-tax.ts\"\nclass MyTaxService extends AbstractTaxService {\n static identifier = \"my-tax\"\n // ...\n}\n```" + }, + { + "kind": "text", + "text": "\n\n---" + } + ] + }, + "children": [ + { + "id": 18, + "name": "getTaxLines", + "variant": "declaration", + "kind": 2048, + "flags": {}, + "signatures": [ + { + "id": 19, + "name": "getTaxLines", + "variant": "signature", + "kind": 4096, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "This method is used when retrieving the tax lines for line items and shipping methods.\nThis occurs during checkout or when calculating totals for orders, swaps, or returns." + } + ], + "blockTags": [ + { + "tag": "@returns", + "content": [ + { + "kind": "text", + "text": "The list of calculated line item and shipping method tax lines.\nIf an item in the array has the " + }, + { + "kind": "code", + "text": "`shipping_method_id`" + }, + { + "kind": "text", + "text": " property, then it's a shipping method tax line. Otherwise, if it has\nthe " + }, + { + "kind": "code", + "text": "`item_id`" + }, + { + "kind": "text", + "text": " property, then it's a line item tax line." + } + ] + }, + { + "tag": "@example", + "content": [ + { + "kind": "text", + "text": "An example of how this method is implemented in the " + }, + { + "kind": "code", + "text": "`system`" + }, + { + "kind": "text", + "text": " provider implemented in the Medusa backend:\n\n" + }, + { + "kind": "code", + "text": "```ts\n// ...\n\nclass SystemTaxService extends AbstractTaxService {\n // ...\n\n async getTaxLines(\n itemLines: ItemTaxCalculationLine[],\n shippingLines: ShippingTaxCalculationLine[],\n context: TaxCalculationContext\n ): Promise {\n let taxLines: ProviderTaxLine[] = itemLines.flatMap((l) => {\n return l.rates.map((r) => ({\n rate: r.rate || 0,\n name: r.name,\n code: r.code,\n item_id: l.item.id,\n }))\n })\n\n taxLines = taxLines.concat(\n shippingLines.flatMap((l) => {\n return l.rates.map((r) => ({\n rate: r.rate || 0,\n name: r.name,\n code: r.code,\n shipping_method_id: l.shipping_method.id,\n }))\n })\n )\n\n return taxLines\n }\n}\n```" + } + ] + } + ] + }, + "parameters": [ + { + "id": 20, + "name": "itemLines", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item lines to calculate taxes for." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 5, + "name": "ItemTaxCalculationLine", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 21, + "name": "shippingLines", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method lines to calculate taxes for." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": 1, + "name": "ShippingTaxCalculationLine", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 22, + "name": "context", + "variant": "param", + "kind": 32768, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Context relevant and useful for the taxes calculation." + } + ] + }, + "type": { + "type": "reference", + "target": 9, + "name": "TaxCalculationContext", + "package": "@medusajs/medusa" + } + } + ], + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts", + "qualifiedName": "Promise" + }, + "typeArguments": [ + { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", + "qualifiedName": "ProviderTaxLine" + }, + "name": "ProviderTaxLine", + "package": "@medusajs/medusa" + } + } + ], + "name": "Promise", + "package": "typescript" + } + } + ] + } + ], + "groups": [ + { + "title": "Methods", + "children": [ + 18 + ] + } + ], + "implementedBy": [ + { + "type": "reference", + "target": 23, + "name": "AbstractTaxService" + } + ] + }, + { + "id": 5, + "name": "ItemTaxCalculationLine", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A line item and the tax rates configured to apply to the\nproduct contained in the line item." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 6, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 7, + "name": "item", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The line item to calculate taxes for." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/line-item.ts", + "qualifiedName": "LineItem" + }, + "name": "LineItem", + "package": "@medusajs/medusa" + } + }, + { + "id": 8, + "name": "rates", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rates applicable on the item." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", + "qualifiedName": "TaxServiceRate" + }, + "name": "TaxServiceRate", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 7, + 8 + ] + } + ] + } + } + }, + { + "id": 1, + "name": "ShippingTaxCalculationLine", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "A shipping method and the tax rates configured to apply to the\nshipping method." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 2, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 4, + "name": "rates", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The rates applicable on the shipping method." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/tax-service.ts", + "qualifiedName": "TaxServiceRate" + }, + "name": "TaxServiceRate", + "package": "@medusajs/medusa" + } + } + }, + { + "id": 3, + "name": "shipping_method", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping method to calculate taxes for." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", + "qualifiedName": "ShippingMethod" + }, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 4, + 3 + ] + } + ] + } + } + }, + { + "id": 9, + "name": "TaxCalculationContext", + "variant": "declaration", + "kind": 2097152, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Information relevant to a tax calculation, such as the shipping address where\nthe items are going." + } + ] + }, + "type": { + "type": "reflection", + "declaration": { + "id": 10, + "name": "__type", + "variant": "declaration", + "kind": 65536, + "flags": {}, + "children": [ + { + "id": 16, + "name": "allocation_map", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The gift cards and discounts applied on line items.\nEach object key or property is an ID of a line item" + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/types/totals.ts", + "qualifiedName": "LineAllocationsMap" + }, + "name": "LineAllocationsMap", + "package": "@medusajs/medusa" + } + }, + { + "id": 12, + "name": "customer", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's customer." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/customer.ts", + "qualifiedName": "Customer" + }, + "name": "Customer", + "package": "@medusajs/medusa" + } + }, + { + "id": 14, + "name": "is_return", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "Whether the cart is used in a return flow." + } + ] + }, + "type": { + "type": "intrinsic", + "name": "boolean" + } + }, + { + "id": 13, + "name": "region", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The cart's region." + } + ] + }, + "type": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/region.ts", + "qualifiedName": "Region" + }, + "name": "Region", + "package": "@medusajs/medusa" + } + }, + { + "id": 11, + "name": "shipping_address", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping address in the cart." + } + ] + }, + "type": { + "type": "union", + "types": [ + { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/address.ts", + "qualifiedName": "Address" + }, + "name": "Address", + "package": "@medusajs/medusa" + }, + { + "type": "literal", + "value": null + } + ] + } + }, + { + "id": 15, + "name": "shipping_methods", + "variant": "declaration", + "kind": 1024, + "flags": {}, + "comment": { + "summary": [ + { + "kind": "text", + "text": "The shipping methods used in the cart." + } + ] + }, + "type": { + "type": "array", + "elementType": { + "type": "reference", + "target": { + "sourceFileName": "../../../packages/medusa/src/models/shipping-method.ts", + "qualifiedName": "ShippingMethod" + }, + "name": "ShippingMethod", + "package": "@medusajs/medusa" + } + } + } + ], + "groups": [ + { + "title": "Properties", + "children": [ + 16, + 12, + 14, + 13, + 11, + 15 + ] + } + ] + } + } + } + ], + "groups": [ + { + "title": "Classes", + "children": [ + 23 + ] + }, + { + "title": "Interfaces", + "children": [ + 17 + ] + }, + { + "title": "Type Aliases", + "children": [ + 5, + 1, + 9 + ] + } + ], + "packageName": "@medusajs/medusa", + "symbolIdMap": { + "0": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "" + }, + "1": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "ShippingTaxCalculationLine" + }, + "2": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type" + }, + "3": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.shipping_method" + }, + "4": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.rates" + }, + "5": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "ItemTaxCalculationLine" + }, + "6": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type" + }, + "7": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.item" + }, + "8": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.rates" + }, + "9": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "TaxCalculationContext" + }, + "10": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type" + }, + "11": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.shipping_address" + }, + "12": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.customer" + }, + "13": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.region" + }, + "14": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.is_return" + }, + "15": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.shipping_methods" + }, + "16": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "__type.allocation_map" + }, + "17": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "ITaxService" + }, + "18": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "ITaxService.getTaxLines" + }, + "19": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "ITaxService.getTaxLines" + }, + "20": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "itemLines" + }, + "21": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "shippingLines" + }, + "22": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "context" + }, + "23": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService" + }, + "25": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService.identifier" + }, + "29": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService.__constructor" + }, + "30": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService" + }, + "31": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "container" + }, + "32": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "config" + }, + "33": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService.container" + }, + "34": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService.config" + }, + "37": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService.getTaxLines" + }, + "38": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "AbstractTaxService.getTaxLines" + }, + "39": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "itemLines" + }, + "40": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "shippingLines" + }, + "41": { + "sourceFileName": "../../../packages/medusa/src/interfaces/tax-service.ts", + "qualifiedName": "context" + }, + "42": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.manager_" + }, + "43": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.transactionManager_" + }, + "44": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "45": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.activeManager_" + }, + "46": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__container__" + }, + "47": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__configModule__" + }, + "48": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.__moduleDeclaration__" + }, + "49": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "50": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.withTransaction" + }, + "51": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "52": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "53": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.shouldRetryTransaction_" + }, + "54": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "err" + }, + "55": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "56": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type.code" + }, + "57": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "58": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TransactionBaseService.atomicPhase_" + }, + "59": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TResult" + }, + "60": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "TError" + }, + "61": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "work" + }, + "62": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "63": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "64": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "transactionManager" + }, + "65": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "isolationOrErrorHandler" + }, + "66": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "67": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "68": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + }, + "69": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "maybeErrorHandlerOrDontFail" + }, + "70": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "71": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "__type" + }, + "72": { + "sourceFileName": "../../../packages/medusa/src/interfaces/transaction-base-service.ts", + "qualifiedName": "error" + } + } +} \ No newline at end of file diff --git a/packages/medusa-file-local/src/services/local-file-service.ts b/packages/medusa-file-local/src/services/local-file-service.ts index e5962221a2..fa38a27b9b 100644 --- a/packages/medusa-file-local/src/services/local-file-service.ts +++ b/packages/medusa-file-local/src/services/local-file-service.ts @@ -14,7 +14,7 @@ class LocalService extends AbstractFileService implements IFileService { protected backendUrl_: string constructor({}, options) { - super({}, options) + super(arguments[0], options) this.uploadDir_ = options.upload_dir || "uploads" this.backendUrl_ = options.backend_url || "http://localhost:9000" diff --git a/packages/medusa-file-minio/src/services/minio.ts b/packages/medusa-file-minio/src/services/minio.ts index 051c75be6b..6181260869 100644 --- a/packages/medusa-file-minio/src/services/minio.ts +++ b/packages/medusa-file-minio/src/services/minio.ts @@ -26,7 +26,7 @@ class MinioService extends AbstractFileService implements IFileService { protected downloadUrlDuration: string | number constructor({}, options) { - super({}, options) + super(arguments[0], options) this.bucket_ = options.bucket this.accessKeyId_ = options.access_key_id diff --git a/packages/medusa-file-s3/src/services/s3.ts b/packages/medusa-file-s3/src/services/s3.ts index 0ac60d5fac..af3d7a6457 100644 --- a/packages/medusa-file-s3/src/services/s3.ts +++ b/packages/medusa-file-s3/src/services/s3.ts @@ -33,7 +33,7 @@ class S3Service extends AbstractFileService implements IFileService { protected client_: S3Client constructor({ logger }, options) { - super({}, options) + super(arguments[0], options) this.prefix_ = options.prefix ? `${options.prefix}/` : '' this.bucket_ = options.bucket diff --git a/packages/medusa-react/src/hooks/admin/claims/mutations.ts b/packages/medusa-react/src/hooks/admin/claims/mutations.ts index e8378ff654..1346201af4 100644 --- a/packages/medusa-react/src/hooks/admin/claims/mutations.ts +++ b/packages/medusa-react/src/hooks/admin/claims/mutations.ts @@ -195,6 +195,16 @@ export const useAdminCancelClaim = ( ) } +/** + * The details of the claim's fulfillment. + */ +export type AdminFulfillClaimReq = AdminPostOrdersOrderClaimsClaimFulfillmentsReq & { + /** + * The claim's ID. + */ + claim_id: string +} + /** * This hook creates a Fulfillment for a Claim, and change its fulfillment status to `partially_fulfilled` or `fulfilled` depending on whether all the items were fulfilled. * It may also change the status to `requires_action` if any actions are required. @@ -238,12 +248,7 @@ export const useAdminFulfillClaim = ( options?: UseMutationOptions< Response, Error, - AdminPostOrdersOrderClaimsClaimFulfillmentsReq & { - /** - * The claim's ID. - */ - claim_id: string - } + AdminFulfillClaimReq > ) => { const { client } = useMedusa() @@ -253,7 +258,7 @@ export const useAdminFulfillClaim = ( ({ claim_id, ...payload - }: AdminPostOrdersOrderClaimsClaimFulfillmentsReq & { claim_id: string }) => + }: AdminFulfillClaimReq) => client.admin.orders.fulfillClaim(orderId, claim_id, payload), buildOptions( queryClient, diff --git a/packages/medusa-react/src/hooks/store/carts/mutations.ts b/packages/medusa-react/src/hooks/store/carts/mutations.ts index 94d26d53dc..18eca0ccaf 100644 --- a/packages/medusa-react/src/hooks/store/carts/mutations.ts +++ b/packages/medusa-react/src/hooks/store/carts/mutations.ts @@ -203,6 +203,16 @@ export const useCreatePaymentSession = ( return useMutation(() => client.carts.createPaymentSessions(cartId), options) } +/** + * The details of the payment session to update. + */ +export type UpdatePaymentSessionReq = StorePostCartsCartPaymentSessionUpdateReq & { + /** + * The payment provider's identifier. + */ + provider_id: string +} + /** * This hook updates a Payment Session with additional data. This can be useful depending on the payment provider used. * All payment sessions are updated and cart totals are recalculated afterwards. @@ -248,17 +258,12 @@ export const useUpdatePaymentSession = ( options?: UseMutationOptions< StoreCartsRes, Error, - { - /** - * The payment provider's identifier. - */ - provider_id: string - } & StorePostCartsCartPaymentSessionUpdateReq + UpdatePaymentSessionReq > ) => { const { client } = useMedusa() return useMutation( - ({ data, provider_id }) => + ({ data, provider_id }: UpdatePaymentSessionReq) => client.carts.updatePaymentSession(cartId, provider_id, { data }), options ) diff --git a/packages/medusa/src/interfaces/file-service.ts b/packages/medusa/src/interfaces/file-service.ts index 99d145d160..1fa77971a0 100644 --- a/packages/medusa/src/interfaces/file-service.ts +++ b/packages/medusa/src/interfaces/file-service.ts @@ -4,62 +4,342 @@ import { FileServiceGetUploadStreamResult, FileServiceUploadResult, GetUploadedFileType, + MedusaContainer, UploadStreamDescriptorType, } from "@medusajs/types" +/** + * ## Overview + * + * A file service class is defined in a TypeScript or JavaScript file that’s created in the `src/services` directory. + * The class must extend the `AbstractFileService` class imported from the `@medusajs/medusa` package. + * + * Based on services’ naming conventions, the file’s name should be the slug version of the file service’s name + * without `service`, and the class’s name should be the pascal case of the file service’s name following by `Service`. + * + * For example, create the file `src/services/local-file.ts` with the following content: + * + * ```ts title="src/services/local-file.ts" + * import { AbstractFileService } from "@medusajs/medusa" + * import { + * DeleteFileType, + * FileServiceGetUploadStreamResult, + * FileServiceUploadResult, + * GetUploadedFileType, + * UploadStreamDescriptorType, + * } from "@medusajs/types" + * + * class LocalFileService extends AbstractFileService { + * async upload( + * fileData: Express.Multer.File + * ): Promise { + * throw new Error("Method not implemented.") + * } + * async uploadProtected( + * fileData: Express.Multer.File + * ): Promise { + * throw new Error("Method not implemented.") + * } + * async delete(fileData: DeleteFileType): Promise { + * throw new Error("Method not implemented.") + * } + * async getUploadStreamDescriptor( + * fileData: UploadStreamDescriptorType + * ): Promise { + * throw new Error("Method not implemented.") + * } + * async getDownloadStream( + * fileData: GetUploadedFileType + * ): Promise { + * throw new Error("Method not implemented.") + * } + * async getPresignedDownloadUrl( + * fileData: GetUploadedFileType + * ): Promise { + * throw new Error("Method not implemented.") + * } + * } + * + * export default LocalFileService + * ``` + * + * :::note[Multer Typing] + * + * The examples implement a file service supporting local uploads. + * + * If you’re using TypeScript and you're following along with the implementation, + * you should install the Multer types package in the root of your Medusa backend to resolve errors within your file service types: + * + * ```bash npm2yarn + * npm install @types/multer + * ``` + * + * ::: + * + * --- + */ export interface IFileService extends TransactionBaseService { /** - * upload file to fileservice - * @param file Multer file from express multipart/form-data - * */ + * This method is used to upload a file to the Medusa backend. + * + * @param {Express.Multer.File} file - A [multer file object](http://expressjs.com/en/resources/middleware/multer.html#file-information). + * The file is uploaded to a temporary directory by default. Among the file’s details, you can access the file’s path in the `path` property of the file object. + * @returns {Promise} The details of the upload's result. + * + * @example + * ```ts + * class LocalFileService extends AbstractFileService { + * // ... + * async upload( + * fileData: Express.Multer.File + * ): Promise { + * const filePath = + * `${this.publicPath}/${fileData.originalname}` + * fs.copyFileSync(fileData.path, filePath) + * return { + * url: `${this.serverUrl}/${filePath}`, + * key: filePath, + * } + * } + * // ... + * } + * ``` + * + * :::tip + * + * This example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name. + * + * ::: + */ upload(file: Express.Multer.File): Promise /** - * upload private file to fileservice - * @param file Multer file from express multipart/form-data - * */ + * This method is used to upload a file to the Medusa backend, but to a protected storage. Typically, this would be used to store files that + * shouldn’t be accessible by using the file’s URL or should only be accessible by authenticated users. For example, exported or imported + * CSV files. + * + * @param {Express.Multer.File} file - A [multer file object](http://expressjs.com/en/resources/middleware/multer.html#file-information). + * The file is uploaded to a temporary directory by default. Among the file’s details, you can access the file’s path in the `path` property of the file object. + * @returns {Promise} The details of the upload's result. + * + * @example + * ```ts + * class LocalFileService extends AbstractFileService { + * // ... + * async uploadProtected( + * fileData: Express.Multer.File + * ): Promise { + * const filePath = + * `${this.protectedPath}/${fileData.originalname}` + * fs.copyFileSync(fileData.path, filePath) + * return { + * url: `${this.serverUrl}/${filePath}`, + * key: filePath + * } + * } + * // ... + * } + * ``` + * + * :::tip + * + * This example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name. + * + * ::: + */ uploadProtected(file: Express.Multer.File): Promise /** - * remove file from fileservice - * @param fileData Remove file described by record - * */ + * This method is used to delete a file from storage. + * + * @param {DeleteFileType} fileData - The details of the file to remove. + * @returns {Promise} Resolves when the file is deleted successfully. + * + * @example + * class LocalFileService extends AbstractFileService { + * + * async delete( + * fileData: DeleteFileType + * ): Promise { + * fs.rmSync(fileData.fileKey) + * } + * + * // ... + * } + */ delete(fileData: DeleteFileType): Promise /** - * upload file to fileservice from stream - * @param fileData file metadata relevant for fileservice to create and upload the file - * */ + * This method is used to retrieve a write stream to be used to upload a file. + * + * @param {UploadStreamDescriptorType} fileData - The details of the file being uploaded. + * @returns {Promise} The result of the file-stream upload. + * + * @example + * // ... + * import { Stream } from "stream" + * + * class LocalFileService extends AbstractFileService { + * // ... + * async getUploadStreamDescriptor({ + * name, + * ext, + * isPrivate = true, + * }: UploadStreamDescriptorType + * ): Promise { + * const filePath = `${isPrivate ? + * this.publicPath : this.protectedPath + * }/${name}.${ext}` + * + * const pass = new Stream.PassThrough() + * const writeStream = fs.createWriteStream(filePath) + * + * pass.pipe(writeStream) + * + * return { + * writeStream: pass, + * promise: Promise.resolve(), + * url: `${this.serverUrl}/${filePath}`, + * fileKey: filePath, + * } + * } + * // ... + * } + */ getUploadStreamDescriptor( fileData: UploadStreamDescriptorType ): Promise /** - * download file from fileservice as stream - * @param fileData file metadata relevant for fileservice to download the file - * @returns readable stream of the file to download - * */ + * This method is used to retrieve a read stream for a file, which can then be used to download the file. + * + * @param {GetUploadedFileType} fileData - The details of the file. + * @returns {Promise} The [read stream](https://nodejs.org/api/webstreams.html#class-readablestream) to read and download the file. + * + * @example + * class LocalFileService extends AbstractFileService { + * + * async getDownloadStream({ + * fileKey, + * isPrivate = true, + * }: GetUploadedFileType + * ): Promise { + * const filePath = `${isPrivate ? + * this.publicPath : this.protectedPath + * }/${fileKey}` + * const readStream = fs.createReadStream(filePath) + * + * return readStream + * } + * + * // ... + * } + */ getDownloadStream( fileData: GetUploadedFileType ): Promise /** - * Generate a presigned download url to obtain a file - * @param fileData file metadata relevant for fileservice to download the file - * @returns presigned url to download the file - * */ + * This method is used to retrieve a download URL of the file. For some file services, such as S3, a presigned URL indicates a temporary URL to get access to a file. + * + * If your file service doesn’t perform or offer a similar functionality, you can just return the URL to download the file. + * + * @param {GetUploadedFileType} fileData - The details of the file. + * @returns {Promise} The presigned URL to download the file + * + * @example + * class LocalFileService extends AbstractFileService { + * + * async getPresignedDownloadUrl({ + * fileKey, + * isPrivate = true, + * }: GetUploadedFileType + * ): Promise { + * // Local upload doesn't provide + * // support for presigned URLs, + * // so just return the file's URL. + * + * const filePath = `${isPrivate ? + * this.publicPath : this.protectedPath + * }/${fileKey}` + * return `${this.serverUrl}/${filePath}` + * } + * + * // ... + * } + */ getPresignedDownloadUrl(fileData: GetUploadedFileType): Promise } + +/** + * @parentIgnore activeManager_,atomicPhase_,shouldRetryTransaction_,withTransaction + */ export abstract class AbstractFileService extends TransactionBaseService implements IFileService { + /** + * @ignore + */ static _isFileService = true + /** + * @ignore + */ static isFileService(object): object is AbstractFileService { return object?.constructor?._isFileService } + /** + * You can use the `constructor` of your file service to access the different services in Medusa through dependency injection. + * + * You can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, + * you can initialize it in the constructor and use it in other methods in the service. + * + * Additionally, if you’re creating your file service as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, + * you can access them in the constructor. + * + * @param {MedusaContainer} container - An instance of `MedusaContainer` that allows you to access other resources, such as services, in your Medusa backend. + * @param {Record} config - If this file service is created in a plugin, the plugin's options are passed in this parameter. + * + * @example + * // ... + * import { Logger } from "@medusajs/medusa" + * import * as fs from "fs" + * + * class LocalFileService extends AbstractFileService { + * // can also be replaced by an environment variable + * // or a plugin option + * protected serverUrl = "http://localhost:9000" + * protected publicPath = "uploads" + * protected protectedPath = "protected-uploads" + * protected logger_: Logger + * + * constructor({ logger }: InjectedDependencies) { + * // @ts-ignore + * super(...arguments) + * this.logger_ = logger + * + * // for public uploads + * if (!fs.existsSync(this.publicPath)) { + * fs.mkdirSync(this.publicPath) + * } + * + * // for protected uploads + * if (!fs.existsSync(this.protectedPath)) { + * fs.mkdirSync(this.protectedPath) + * } + * } + * // ... + * } + */ + protected constructor( + protected readonly container: MedusaContainer, + protected readonly config?: Record // eslint-disable-next-line @typescript-eslint/no-empty-function + ) { + super(container, config) + } + abstract upload( fileData: Express.Multer.File ): Promise diff --git a/packages/medusa/src/interfaces/fulfillment-service.ts b/packages/medusa/src/interfaces/fulfillment-service.ts index e75a0bdfba..26f946d1b7 100644 --- a/packages/medusa/src/interfaces/fulfillment-service.ts +++ b/packages/medusa/src/interfaces/fulfillment-service.ts @@ -411,6 +411,7 @@ export abstract class AbstractFulfillmentService /** * You can use the `constructor` of your fulfillment provider to access the different services in Medusa through dependency injection. + * * You can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the service. * Additionally, if you’re creating your fulfillment provider as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, you can access it in the constructor. * diff --git a/packages/medusa/src/interfaces/notification-service.ts b/packages/medusa/src/interfaces/notification-service.ts index 3f7a0cd2f7..40ef37995f 100644 --- a/packages/medusa/src/interfaces/notification-service.ts +++ b/packages/medusa/src/interfaces/notification-service.ts @@ -1,18 +1,196 @@ +import { MedusaContainer } from "@medusajs/types" import { TransactionBaseService } from "./transaction-base-service" -type ReturnedData = { +/** + * @interface + * + * The details of a sent or resent notification. + */ +export type ReturnedData = { + /** + * The receiver of the Notification. For example, if you sent an email to the customer then `to` is the email address of the customer. + * In other cases, it might be a phone number or a username. + */ to: string + /** + * The status of the sent notification. There are no restriction on the returned status. + */ status: string + /** + * The data used to send the Notification. For example, if you sent an order confirmation email to the customer, then the `data` object + * might include the order items or the subject of the email. This `data` is necessary if the notification is resent later as you can use the same data. + */ data: Record } +/** + * ## Overview + * + * :::note[Prerequisites] + * + * Before creating a Notification Provider, [install an event bus module](https://docs.medusajs.com/development/events/modules/redis). + * + * ::: + * + * A Notification Provider is a provider that handles sending and resending of notifications. + * + * To create a Notification Provider, create a TypeScript or JavaScript file in `src/services`. The name of the file is the name of the provider + * (for example, `sendgrid.ts`). The file must export a class that extends the `AbstractNotificationService` class imported from `@medusajs/medusa`. + * + * For example, create the file `src/services/email-sender.ts` with the following content: + * + * ```ts title="src/services/email-sender.ts" + * import { AbstractNotificationService } from "@medusajs/medusa" + * import { EntityManager } from "typeorm" + * + * class EmailSenderService extends AbstractNotificationService { + * protected manager_: EntityManager + * protected transactionManager_: EntityManager + * + * sendNotification( + * event: string, + * data: unknown, + * attachmentGenerator: unknown + * ): Promise<{ + * to: string; + * status: string; + * data: Record; + * }> { + * throw new Error("Method not implemented.") + * } + * resendNotification( + * notification: unknown, + * config: unknown, + * attachmentGenerator: unknown + * ): Promise<{ + * to: string; + * status: string; + * data: Record; + * }> { + * throw new Error("Method not implemented.") + * } + * + * } + * + * export default EmailSenderService + * ``` + * + * --- + * + * ## Identifier Property + * + * The `NotificationProvider` entity has 2 properties: `identifier` and `is_installed`. The value of the `identifier` property in the notification provider + * class is used when the Notification Provider is created in the database. + * + * The value of this property is also used later when you want to subscribe the Notification Provider to events in a [Loader](https://docs.medusajs.com/development/loaders/overview). + * + * For example: + * + * ```ts + * class EmailSenderService extends AbstractNotificationService { + * static identifier = "email-sender" + * // ... + * } + * ``` + * + * --- + */ export interface INotificationService extends TransactionBaseService { + /** + * When an event is triggered that your Notification Provider is registered as a handler for, the [`NotificationService`](https://docs.medusajs.com/references/services/classes/services.NotificationService) + * in the Medusa backend executes this method of your Notification Provider. + * + * In this method, you can perform the necessary operation to send the Notification. For example, you can send an email to the customer when they place an order. + * + * @param {string} event - The name of the event that was triggered. For example, `order.placed`. + * @param {unknown} data - The data payload of the event that was triggered. For example, if the `order.placed` event is triggered, + * the `eventData` object contains the property `id` which is the ID of the order that was placed. You can refer to the + * [Events reference](https://docs.medusajs.com/development/events/events-list) for information on all events and their payloads. + * @param {unknown} attachmentGenerator - If you’ve previously register an attachment generator to the `NotificationService` using the + * [`registerAttachmentGenerator`](https://docs.medusajs.com/references/services/classes/services.NotificationService#registerattachmentgenerator) method, + * you have access to it here. You can use the `attachmentGenerator` to generate on-demand invoices or other documents. The default value of this parameter is `null`. + * @returns {Promise} The sending details. + * + * @example + * class EmailSenderService extends AbstractNotificationService { + * // ... + * async sendNotification( + * event: string, + * data: any, + * attachmentGenerator: unknown + * ): Promise<{ + * to: string; + * status: string; + * data: Record; + * }> { + * if (event === "order.placed") { + * // retrieve order + * const order = await this.orderService.retrieve(data.id) + * // TODO send email + * + * console.log("Notification sent") + * return { + * to: order.email, + * status: "done", + * data: { + * // any data necessary to send the email + * // for example: + * subject: "You placed a new order!", + * items: order.items, + * }, + * } + * } + * } + * // ... + * } + */ sendNotification( event: string, data: unknown, attachmentGenerator: unknown ): Promise + /** + * This method is used to resend notifications, which is typically triggered by the + * [Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend). + * + * @param {unknown} notification - The original [Notification record](https://docs.medusajs.com/references/entities/classes/Notification) that was created after you sent the + * notification with `sendNotification`. It includes the `to` and `data` attributes which are populated originally using the `to` and `data` properties of + * the object you return in {@link sendNotification}. + * @param {unknown} config - The new configuration used to resend the notification. The [Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend), + * allows you to pass a new `to` field. If specified, it will be available in this config object. + * @param {unknown} attachmentGenerator - f you’ve previously register an attachment generator to the `NotificationService` using the + * [`registerAttachmentGenerator`](https://docs.medusajs.com/references/services/classes/services.NotificationService#registerattachmentgenerator) method, + * you have access to it here. You can use the `attachmentGenerator` to generate on-demand invoices or other documents. The default value of this parameter is `null`. + * @returns {Promise} The resend details. + * + * @example + * class EmailSenderService extends AbstractNotificationService { + * // ... + * async resendNotification( + * notification: any, + * config: any, + * attachmentGenerator: unknown + * ): Promise<{ + * to: string; + * status: string; + * data: Record; + * }> { + * // check if the receiver should be changed + * const to: string = config.to || notification.to + * + * // TODO resend the notification using the same data + * // that is saved under notification.data + * + * console.log("Notification resent") + * return { + * to, + * status: "done", + * data: notification.data, // make changes to the data + * } + * } + * } + */ resendNotification( notification: unknown, config: unknown, @@ -20,21 +198,78 @@ export interface INotificationService extends TransactionBaseService { ): Promise } +/** + * @parentIgnore activeManager_,atomicPhase_,shouldRetryTransaction_,withTransaction + */ export abstract class AbstractNotificationService extends TransactionBaseService implements INotificationService { + /** + * @ignore + */ static _isNotificationService = true static identifier: string + /** + * @ignore + */ static isNotificationService(object): boolean { return object?.constructor?._isNotificationService } + /** + * @ignore + */ getIdentifier(): string { return (this.constructor as any).identifier } + /** + * You can use the `constructor` of your notification provider to access the different services in Medusa through dependency injection. + * + * You can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, + * you can initialize it in the constructor and use it in other methods in the service. + * + * Additionally, if you’re creating your notification provider as an external plugin to be installed on any Medusa backend and you want to access the options + * added for the plugin, you can access it in the constructor. + * + * @param {MedusaContainer} container - An instance of `MedusaContainer` that allows you to access other resources, such as services, in your Medusa backend. + * @param {Record} config - If this notification provider is created in a plugin, the plugin's options are passed in this parameter. + * + * @example + * // ... + * import { AbstractNotificationService, OrderService } from "@medusajs/medusa" + * import { EntityManager } from "typeorm" + * + * class EmailSenderService extends AbstractNotificationService { + * // ... + * protected orderService: OrderService + * + * constructor(container, options) { + * super(container) + * // you can access options here in case you're + * // using a plugin + * + * this.orderService = container.orderService + * + * // you can also initialize a client that + * // communicates with a third-party service. + * this.client = new Client(options) + * } + * + * // ... + * } + * + * export default EmailSenderService + */ + protected constructor( + protected readonly container: MedusaContainer, + protected readonly config?: Record // eslint-disable-next-line @typescript-eslint/no-empty-function + ) { + super(container, config) + } + abstract sendNotification( event: string, data: unknown, diff --git a/packages/medusa/src/interfaces/price-selection-strategy.ts b/packages/medusa/src/interfaces/price-selection-strategy.ts index b09cd488e1..f621334ff8 100644 --- a/packages/medusa/src/interfaces/price-selection-strategy.ts +++ b/packages/medusa/src/interfaces/price-selection-strategy.ts @@ -1,24 +1,153 @@ import { MoneyAmount } from "../models" import { PriceListType } from "../types/price-list" import { TaxServiceRate } from "../types/tax-service" -import { ITransactionBaseService } from "@medusajs/types" +import { ITransactionBaseService, MedusaContainer } from "@medusajs/types" import { TransactionBaseService } from "./transaction-base-service" +/** + * ## Overview + * + * The price selection strategy retrieves the best price for a product variant for a specific context such as selected region, taxes applied, + * the quantity in cart, and more. + * + * Medusa provides a default price selection strategy, but you can override it. A price selecion strategy is a TypeScript or JavaScript file in the `src/strategies` directory of your Medusa backend project. It exports a class that extends the `AbstractPriceSelectionStrategy` class. + * + * For example: + * + * ```ts title="src/strategies/price.ts" + * import { + * AbstractPriceSelectionStrategy, + * PriceSelectionContext, + * PriceSelectionResult, + * } from "@medusajs/medusa" + * + * export default class MyStrategy extends + * AbstractPriceSelectionStrategy { + * + * async calculateVariantPrice( + * data: { + * variantId: string; + * quantity?: number + * }[], + * context: PriceSelectionContext + * ): Promise> { + * throw new Error("Method not implemented.") + * } + * } + * ``` + * + * --- + */ export interface IPriceSelectionStrategy extends ITransactionBaseService { /** - * Calculate the original and discount price for a given variant in a set of - * circumstances described in the context. - * @return pricing details in an object containing the calculated lowest price, - * the default price an all valid prices for the given variant + * This method retrieves one or more product variants' prices. It's used when retrieving product variants or their associated line items. + * It's also used when retrieving other entities that product variants and line items belong to, such as products and carts respectively. + * + * @param data - The necessary data to perform the price selection for each variant ID. + * @param context - The context of the price selection. + * @returns {Promise>} A map, each key is an ID of a variant, and its value is an object holding the price selection result. + * + * @example + * For example, here's a snippet of how the price selection strategy is implemented in the Medusa backend: + * + * ```ts + * import { + * AbstractPriceSelectionStrategy, + * CustomerService, + * PriceSelectionContext, + * PriceSelectionResult, + * } from "@medusajs/medusa" + * + * type InjectedDependencies = { + * customerService: CustomerService + * } + * + * export default class MyStrategy extends + * AbstractPriceSelectionStrategy { + * + * async calculateVariantPrice( + * data: { + * variantId: string + * quantity?: number + * }[], + * context: PriceSelectionContext + * ): Promise> { + * const dataMap = new Map(data.map((d) => [d.variantId, d])) + * + * const cacheKeysMap = new Map( + * data.map(({ variantId, quantity }) => [ + * variantId, + * this.getCacheKey(variantId, { ...context, quantity }), + * ]) + * ) + * + * const nonCachedData: { + * variantId: string + * quantity?: number + * }[] = [] + * + * const variantPricesMap = new Map() + * + * if (!context.ignore_cache) { + * const cacheHits = await promiseAll( + * [...cacheKeysMap].map(async ([, cacheKey]) => { + * return await this.cacheService_.get(cacheKey) + * }) + * ) + * + * if (!cacheHits.length) { + * nonCachedData.push(...dataMap.values()) + * } + * + * for (const [index, cacheHit] of cacheHits.entries()) { + * const variantId = data[index].variantId + * if (cacheHit) { + * variantPricesMap.set(variantId, cacheHit) + * continue + * } + * + * nonCachedData.push(dataMap.get(variantId)!) + * } + * } else { + * nonCachedData.push(...dataMap.values()) + * } + * + * let results: Map = new Map() + * + * if ( + * this.featureFlagRouter_.isFeatureEnabled( + * TaxInclusivePricingFeatureFlag.key + * ) + * ) { + * results = await this.calculateVariantPrice_new(nonCachedData, context) + * } else { + * results = await this.calculateVariantPrice_old(nonCachedData, context) + * } + * + * await promiseAll( + * [...results].map(async ([variantId, prices]) => { + * variantPricesMap.set(variantId, prices) + * if (!context.ignore_cache) { + * await this.cacheService_.set(cacheKeysMap.get(variantId)!, prices) + * } + * }) + * ) + * + * return variantPricesMap + * } + * + * // ... + * } + * ``` */ calculateVariantPrice( data: { /** - * The variant id of the variant for which to retrieve prices + * The ID of the variant to retrieve its prices. */ variantId: string /** - * The variant's quantity. + * The variant's quantity in the cart, if available. */ quantity?: number }[], @@ -29,25 +158,114 @@ export interface IPriceSelectionStrategy extends ITransactionBaseService { ): Promise> /** - * Notify price selection strategy that variants prices have been updated. - * @param variantIds The ids of the updated variants + * This method is called when prices of product variants have changed. + * You can use it to invalidate prices stored in the cache. + * + * @param {string[]} variantIds - The IDs of the updated variants. + * @returns {Promise} Resolves after any necessary actions are performed. + * + * @example + * For example, this is how this method is implemented in the Medusa backend's default + * price selection strategy: + * + * ```ts + * import { + * AbstractPriceSelectionStrategy, + * CustomerService, + * } from "@medusajs/medusa" + * import { promiseAll } from "@medusajs/utils" + * + * type InjectedDependencies = { + * customerService: CustomerService + * } + * + * export default class MyStrategy extends + * AbstractPriceSelectionStrategy { + * + * public async onVariantsPricesUpdate(variantIds: string[]): Promise { + * await promiseAll( + * variantIds.map( + * async (id: string) => await this.cacheService_.invalidate(`ps:${id}:*`) + * ) + * ) + * } + * + * // ... + * } + * ``` + * + * :::note + * + * Learn more about the cache service in [this documentation](https://docs.medusajs.com/development/cache/overview). + * + * ::: */ onVariantsPricesUpdate(variantIds: string[]): Promise } +/** + * @parentIgnore activeManager_,atomicPhase_,shouldRetryTransaction_,withTransaction + */ export abstract class AbstractPriceSelectionStrategy extends TransactionBaseService implements IPriceSelectionStrategy { + /** + * @ignore + */ static _isPriceSelectionStrategy = true + /** + * @ignore + */ static isPriceSelectionStrategy(object): boolean { return object?.constructor?._isPriceSelectionStrategy } + /** + * You can use the `constructor` of your price-selection strategy to access the different services in Medusa through dependency injection. + * + * @param {MedusaContainer} container - An instance of `MedusaContainer` that allows you to access other resources, such as services, in your Medusa backend. + * @param {Record} config - If this price-selection strategy is created in a plugin, the plugin's options are passed in this parameter. + * + * @example + * // ... + * import { + * AbstractPriceSelectionStrategy, + * CustomerService, + * } from "@medusajs/medusa" + * type InjectedDependencies = { + * customerService: CustomerService + * } + * + * class MyStrategy extends + * AbstractPriceSelectionStrategy { + * + * protected customerService_: CustomerService + * + * constructor(container: InjectedDependencies) { + * super(container) + * this.customerService_ = container.customerService + * } + * + * // ... + * } + * + * export default MyStrategy + */ + protected constructor( + protected readonly container: MedusaContainer, + protected readonly config?: Record // eslint-disable-next-line @typescript-eslint/no-empty-function + ) { + super(container, config) + } + public abstract calculateVariantPrice( data: { variantId: string + /** + * @ignore + */ taxRates: TaxServiceRate[] quantity?: number }[], @@ -59,18 +277,59 @@ export abstract class AbstractPriceSelectionStrategy } } +/** + * @interface + * + * The context of the price selection. + */ export type PriceSelectionContext = { + /** + * The cart's ID. This is used when the prices are being retrieved for the variant of a line item, + * as it is used to determine the current region and currency code of the context. + */ cart_id?: string + /** + * The ID of the customer viewing the variant. + */ customer_id?: string + /** + * The region's ID. + */ region_id?: string + /** + * The quantity of the item in the cart. This is used to filter out price lists that have + * `min_quantity` or `max_quantity` conditions set. + */ quantity?: number + /** + * The currency code the customer is using. + */ currency_code?: string + /** + * Whether the price list's prices should be retrieved or not. + */ include_discount_prices?: boolean + /** + * The tax rates to be applied. This is only used for + * [Tax-Inclusive Pricing](https://docs.medusajs.com/modules/taxes/inclusive-pricing). + */ tax_rates?: TaxServiceRate[] + /** + * Whether to calculate the prices even if the value of an earlier price calculation + * is available in the cache. + */ ignore_cache?: boolean } +/** + * @enum + * + * The type of default price type. + */ enum DefaultPriceType { + /** + * The `calculatedPrice` is the original price. + */ DEFAULT = "default", } @@ -78,11 +337,38 @@ enum DefaultPriceType { export type PriceType = DefaultPriceType | PriceListType export const PriceType = { ...DefaultPriceType, ...PriceListType } +/** + * @interface + * + * The price selection result of a variant. + */ export type PriceSelectionResult = { + /** + * The original price of the variant which depends on the selected region or currency code in the context object. + * If both region ID and currency code are available in the context object, the region has higher precedence. + */ originalPrice: number | null + /** + * Whether the original price includes taxes or not. This is only available + * for [Tax-Inclusive Pricing](https://docs.medusajs.com/modules/taxes/inclusive-pricing). + */ originalPriceIncludesTax?: boolean | null + /** + * The lowest price among the prices of the product variant retrieved using the context object. + */ calculatedPrice: number | null + /** + * Whether the calculated price includes taxes or not. + * This is only available for [Tax-Inclusive Pricing](https://docs.medusajs.com/modules/taxes/inclusive-pricing). + */ calculatedPriceIncludesTax?: boolean | null + /** + * The type of price applied in `calculatedPrice`. + */ calculatedPriceType?: PriceType - prices: MoneyAmount[] // prices is an array of all possible price for the input customer and region prices + /** + * All possible prices of the variant that are retrieved using the `context` object. + * It can include its original price and its price lists if there are any. + */ + prices: MoneyAmount[] } diff --git a/packages/medusa/src/interfaces/tax-calculation-strategy.ts b/packages/medusa/src/interfaces/tax-calculation-strategy.ts index 82b7e0215e..95c2cb8dcb 100644 --- a/packages/medusa/src/interfaces/tax-calculation-strategy.ts +++ b/packages/medusa/src/interfaces/tax-calculation-strategy.ts @@ -3,15 +3,95 @@ import { TaxCalculationContext } from "./tax-service" import { LineItemTaxLine } from "../models/line-item-tax-line" import { ShippingMethodTaxLine } from "../models/shipping-method-tax-line" import { TransactionBaseService } from "./transaction-base-service" +import { MedusaContainer } from "@medusajs/types" +/** + * ## Overview + * + * A tax calculation strategy is used to calculate taxes when calculating a cart's totals. The Medusa + * backend provides a tax calculation strategy that handles calculating the taxes, taking into account the + * defined tax rates and settings such as whether tax-inclusive pricing is enabled. + * + * You can override the tax calculation strategy to implement different calculation logic or to + * integrate a third-party service that handles the tax calculation. You can override it either + * in a Medusa backend setup or in a plugin. + * + * A tax calculation strategy should be defined in a TypeScript or JavaScript file created under the `src/strategies` directory. + * The class must also implement the `ITaxCalculationStrategy` interface imported from the `@medusajs/medusa` package. + * + * For example, you can create the file `src/strategies/tax-calculation.ts` with the following content: + * + * ```ts title="src/strategies/tax-calculation.ts" + * import { + * ITaxCalculationStrategy, + * LineItem, + * LineItemTaxLine, + * ShippingMethodTaxLine, + * TaxCalculationContext, + * } from "@medusajs/medusa" + * + * class TaxCalculationStrategy + * implements ITaxCalculationStrategy { + * + * async calculate( + * items: LineItem[], + * taxLines: (ShippingMethodTaxLine | LineItemTaxLine)[], + * calculationContext: TaxCalculationContext + * ): Promise { + * throw new Error("Method not implemented.") + * } + * + * } + * + * export default TaxCalculationStrategy + * ``` + * + * --- + */ export interface ITaxCalculationStrategy { /** - * Calculates the tax amount for a given set of line items under applicable + * This method calculates the tax amount for a given set of line items under applicable * tax conditions and calculation contexts. - * @param items - the line items to calculate the tax total for - * @param taxLines - the tax lines that applies to the calculation - * @param calculationContext - other details relevant for the calculation - * @return the tax total + * + * This method is used whenever taxes are calculated. If automatic tax calculation is disabled in a region, + * then it's only triggered when taxes are calculated manually as explained in + * [this guide](https://docs.medusajs.com/modules/taxes/storefront/manual-calculation). + * + * @param {LineItem[]} items - The line items to calculate the tax total for. + * @param {(ShippingMethodTaxLine | LineItemTaxLine)[]} taxLines - The tax lines used for the calculation + * @param {TaxCalculationContext} calculationContext - Other details relevant for the calculation + * @returns {Promise} The calculated tax total + * + * @example + * An example of the general implementation of this method in the Medusa backend's tax calculation strategy: + * + * ```ts + * async calculate( + * items: LineItem[], + * taxLines: (ShippingMethodTaxLine | LineItemTaxLine)[], + * calculationContext: TaxCalculationContext + * ): Promise { + * const lineItemsTaxLines = taxLines.filter( + * (tl) => "item_id" in tl + * ) as LineItemTaxLine[] + * const shippingMethodsTaxLines = taxLines.filter( + * (tl) => "shipping_method_id" in tl + * ) as ShippingMethodTaxLine[] + * + * const lineItemsTax = this.calculateLineItemsTax( + * items, + * lineItemsTaxLines, + * calculationContext + * ) + * + * const shippingMethodsTax = this.calculateShippingMethodsTax( + * calculationContext.shipping_methods, + * shippingMethodsTaxLines + * ) + * + * return Math.round(lineItemsTax + shippingMethodsTax) + * } + * ``` */ calculate( items: LineItem[], @@ -20,12 +100,21 @@ export interface ITaxCalculationStrategy { ): Promise } +/** + * @parentIgnore activeManager_,atomicPhase_,shouldRetryTransaction_,withTransaction + */ export abstract class AbstractTaxCalculationStrategy extends TransactionBaseService implements ITaxCalculationStrategy { + /** + * @ignore + */ static _isTaxCalculationStrategy = true + /** + * @ignore + */ static isTaxCalculationStrategy(object): boolean { return ( typeof object.calculate === "function" || @@ -33,6 +122,46 @@ export abstract class AbstractTaxCalculationStrategy ) } + /** + * You can use the `constructor` of your tax calculation strategy to access the different services in Medusa through dependency injection. + * + * You can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the service. + * Additionally, if you’re creating your tax calculation strategy as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, you can access it in the constructor. + * + * @param {MedusaContainer} container - An instance of `MedusaContainer` that allows you to access other resources, such as services, in your Medusa backend. + * @param {Record} config - If this tax calculation strategy is created in a plugin, the plugin's options are passed in this parameter. + * + * @example + * import { + * ITaxCalculationStrategy, + * LineItemService, + * } from "@medusajs/medusa" + * + * type InjectedDependencies = { + * lineItemService: LineItemService + * } + * + * class TaxCalculationStrategy + * implements ITaxCalculationStrategy { + * + * protected readonly lineItemService_: LineItemService + * + * constructor({ lineItemService }: InjectedDependencies) { + * this.lineItemService_ = lineItemService + * } + * + * // ... + * } + * + * export default TaxCalculationStrategy + */ + protected constructor( + protected readonly container: MedusaContainer, + protected readonly config?: Record // eslint-disable-next-line @typescript-eslint/no-empty-function + ) { + super(container, config) + } + abstract calculate( items: LineItem[], taxLines: (ShippingMethodTaxLine | LineItemTaxLine)[], diff --git a/packages/medusa/src/interfaces/tax-service.ts b/packages/medusa/src/interfaces/tax-service.ts index 31c74c3ef4..c8c38e070c 100644 --- a/packages/medusa/src/interfaces/tax-service.ts +++ b/packages/medusa/src/interfaces/tax-service.ts @@ -6,22 +6,35 @@ import { Customer } from "../models/customer" import { ProviderTaxLine, TaxServiceRate } from "../types/tax-service" import { LineAllocationsMap } from "../types/totals" import { TransactionBaseService } from "./transaction-base-service" +import { MedusaContainer } from "@medusajs/types" /** - * A shipping method and the tax rates that have been configured to apply to the + * A shipping method and the tax rates configured to apply to the * shipping method. */ export type ShippingTaxCalculationLine = { + /** + * The shipping method to calculate taxes for. + */ shipping_method: ShippingMethod + /** + * The rates applicable on the shipping method. + */ rates: TaxServiceRate[] } /** - * A line item and the tax rates that have been configured to apply to the + * A line item and the tax rates configured to apply to the * product contained in the line item. */ export type ItemTaxCalculationLine = { + /** + * The line item to calculate taxes for. + */ item: LineItem + /** + * The rates applicable on the item. + */ rates: TaxServiceRate[] } @@ -30,27 +43,135 @@ export type ItemTaxCalculationLine = { * the items are going. */ export type TaxCalculationContext = { + /** + * The shipping address used in the cart. + */ shipping_address: Address | null + /** + * The customer that the cart belongs to. + */ customer: Customer + /** + * The cart's region. + */ region: Region + /** + * Whether the cart is used in a return flow. + */ is_return: boolean + /** + * The shipping methods used in the cart. + */ shipping_methods: ShippingMethod[] + /** + * The gift cards and discounts applied on line items. + * Each object key or property is an ID of a line item + */ allocation_map: LineAllocationsMap } /** - * Interface to be implemented by tax provider plugins. The interface defines a - * single method `getTaxLines` that returns numerical rates to apply to line - * items and shipping methods. + * ## Overview + * + * A tax provider is used to retrieve the tax lines in a cart. The Medusa backend provides a default `system` provider. You can create your own tax provider, + * either in a plugin or directly in your Medusa backend, then use it in any region. + * + * A tax provider class is defined in a TypeScript or JavaScript file under the `src/services` directory and the class must extend the + * `AbstractTaxService` class imported from `@medusajs/medusa`. The file's name is the tax provider's class name as a slug and without the word `Service`. + * + * For example, you can create the file `src/services/my-tax.ts` with the following content: + * + * ```ts title="src/services/my-tax.ts" + * import { + * AbstractTaxService, + * ItemTaxCalculationLine, + * ShippingTaxCalculationLine, + * TaxCalculationContext, + * } from "@medusajs/medusa" + * import { + * ProviderTaxLine, + * } from "@medusajs/medusa/dist/types/tax-service" + * + * class MyTaxService extends AbstractTaxService { + * async getTaxLines( + * itemLines: ItemTaxCalculationLine[], + * shippingLines: ShippingTaxCalculationLine[], + * context: TaxCalculationContext): + * Promise { + * throw new Error("Method not implemented.") + * } + * } + * + * export default MyTaxService + * ``` + * + * --- + * + * ## Identifier Property + * + * The `TaxProvider` entity has 2 properties: `identifier` and `is_installed`. The `identifier` property in the tax provider service is used when the tax provider is added to the database. + * + * The value of this property is also used to reference the tax provider throughout Medusa. For example, it is used to [change the tax provider](https://docs.medusajs.com/modules/taxes/admin/manage-tax-settings#change-tax-provider-of-a-region) to a region. + * + * ```ts title="src/services/my-tax.ts" + * class MyTaxService extends AbstractTaxService { + * static identifier = "my-tax" + * // ... + * } + * ``` + * + * --- */ export interface ITaxService { /** - * Retrieves the numerical tax lines for a calculation context. - * @param itemLines - the line item calculation lines - * @param itemLines - the shipping calculation lines - * @param context - other details relevant to the tax determination - * @return numerical tax rates that should apply to the provided calculation - * lines + * This method is used when retrieving the tax lines for line items and shipping methods. + * This occurs during checkout or when calculating totals for orders, swaps, or returns. + * + * @param {ItemTaxCalculationLine[]} itemLines - The line item lines to calculate taxes for. + * @param {ShippingTaxCalculationLine[]} shippingLines - The shipping method lines to calculate taxes for. + * @param {TaxCalculationContext} context - Context relevant and useful for the taxes calculation. + * @return {Promise} The list of calculated line item and shipping method tax lines. + * If an item in the array has the `shipping_method_id` property, then it's a shipping method tax line. Otherwise, if it has + * the `item_id` property, then it's a line item tax line. + * + * @example + * An example of how this method is implemented in the `system` provider implemented in the Medusa backend: + * + * ```ts + * // ... + * + * class SystemTaxService extends AbstractTaxService { + * // ... + * + * async getTaxLines( + * itemLines: ItemTaxCalculationLine[], + * shippingLines: ShippingTaxCalculationLine[], + * context: TaxCalculationContext + * ): Promise { + * let taxLines: ProviderTaxLine[] = itemLines.flatMap((l) => { + * return l.rates.map((r) => ({ + * rate: r.rate || 0, + * name: r.name, + * code: r.code, + * item_id: l.item.id, + * })) + * }) + * + * taxLines = taxLines.concat( + * shippingLines.flatMap((l) => { + * return l.rates.map((r) => ({ + * rate: r.rate || 0, + * name: r.name, + * code: r.code, + * shipping_method_id: l.shipping_method.id, + * })) + * }) + * ) + * + * return taxLines + * } + * } + * ``` */ getTaxLines( itemLines: ItemTaxCalculationLine[], @@ -59,17 +180,70 @@ export interface ITaxService { ): Promise } +/** + * @parentIgnore activeManager_,atomicPhase_,shouldRetryTransaction_,withTransaction + */ export abstract class AbstractTaxService extends TransactionBaseService implements ITaxService { + /** + * @ignore + */ static _isTaxService = true protected static identifier: string + /** + * @ignore + */ static isTaxService(object): boolean { return object?.constructor?._isTaxService } + /** + * You can use the `constructor` of your tax provider to access the different services in Medusa through dependency injection. + * + * You can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the service. + * Additionally, if you’re creating your tax provider as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, you can access it in the constructor. + * + * @param {MedusaContainer} container - An instance of `MedusaContainer` that allows you to access other resources, such as services, in your Medusa backend. + * @param {Record} config - If this tax provider is created in a plugin, the plugin's options are passed in this parameter. + * + * @example + * // ... + * import { LineItemService } from "@medusajs/medusa" + * + * type InjectedDependencies = { + * lineItemService: LineItemService + * } + * + * class MyTaxService extends AbstractTaxService { + * protected readonly lineItemService_: LineItemService + * + * constructor({ lineItemService }: InjectedDependencies) { + * super(arguments[0]) + * this.lineItemService_ = lineItemService + * + * // you can also initialize a client that + * // communicates with a third-party service. + * this.client = new Client(options) + * } + * + * // ... + * } + * + * export default MyTaxService + */ + protected constructor( + protected readonly container: MedusaContainer, + protected readonly config?: Record // eslint-disable-next-line @typescript-eslint/no-empty-function + ) { + super(container, config) + } + + /** + * @ignore + */ public getIdentifier(): string { if (!(this.constructor as typeof AbstractTaxService).identifier) { throw new Error(`Missing static property "identifier".`) diff --git a/packages/medusa/src/services/system-tax.ts b/packages/medusa/src/services/system-tax.ts index ce9532d90d..6bf2437215 100644 --- a/packages/medusa/src/services/system-tax.ts +++ b/packages/medusa/src/services/system-tax.ts @@ -9,8 +9,10 @@ import { ProviderTaxLine } from "../types/tax-service" class SystemTaxService extends AbstractTaxService { static identifier = "system" - constructor() { - super({}) + constructor(...args: any[]) { + // @ts-ignore + // eslint-disable-next-line prefer-rest-params + super(...arguments) } async getTaxLines( diff --git a/packages/medusa/src/types/tax-service.ts b/packages/medusa/src/types/tax-service.ts index 66e91d04c6..eeca0dc0a7 100644 --- a/packages/medusa/src/types/tax-service.ts +++ b/packages/medusa/src/types/tax-service.ts @@ -31,10 +31,25 @@ export type TaxServiceRate = { * The tax line properties for a given shipping method. */ export type ProviderShippingMethodTaxLine = { + /** + * The tax rate. + */ rate: number + /** + * The tax rate's name. + */ name: string + /** + * The tax code. + */ code: string | null + /** + * Holds any necessary additional data to be added to the shipping method tax lines. + */ metadata?: Record + /** + * The shipping method's ID. + */ shipping_method_id: string } @@ -42,10 +57,25 @@ export type ProviderShippingMethodTaxLine = { * The tax line properties for a given line item. */ export type ProviderLineItemTaxLine = { + /** + * The tax rate. + */ rate: number + /** + * The tax rate's name. + */ name: string + /** + * The tax code. + */ code: string | null + /** + * The line item's ID. + */ item_id: string + /** + * Holds any necessary additional data to be added to the line item tax lines. + */ metadata?: Record } diff --git a/packages/medusa/src/types/totals.ts b/packages/medusa/src/types/totals.ts index a050d7d48d..de8d4930bc 100644 --- a/packages/medusa/src/types/totals.ts +++ b/packages/medusa/src/types/totals.ts @@ -37,7 +37,16 @@ export type DiscountAllocation = { * allocations */ export type LineAllocationsMap = { - [K: string]: { gift_card?: GiftCardAllocation; discount?: DiscountAllocation } + [K: string]: { + /** + * The gift card applied on the line item. + */ + gift_card?: GiftCardAllocation + /** + * The discount applied on the line item. + */ + discount?: DiscountAllocation + } } /** diff --git a/packages/types/src/common/config-module.ts b/packages/types/src/common/config-module.ts index 452ac03d76..2b20bd9e33 100644 --- a/packages/types/src/common/config-module.ts +++ b/packages/types/src/common/config-module.ts @@ -5,56 +5,541 @@ import { InternalModuleDeclaration, } from "../modules-sdk" +/** + * @interface + * + * Options to pass to `express-session`. + */ type SessionOptions = { + /** + * The name of the session ID cookie to set in the response (and read from in the request). The default value is `connect.sid`. + * Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#name) for more details. + */ name?: string + /** + * Whether the session should be saved back to the session store, even if the session was never modified during the request. The default value is `true`. + * Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#resave) for more details. + */ resave?: boolean + /** + * Whether the session identifier cookie should be force-set on every response. The default value is `false`. + * Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#rolling) for more details. + */ rolling?: boolean + /** + * Whether a session that is "uninitialized" is forced to be saved to the store. The default value is `true`. + * Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#saveUninitialized) for more details. + */ saveUninitialized?: boolean + /** + * The secret to sign the session ID cookie. By default, the value of `cookie_secret` is used. + * Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#secret) for details. + */ secret?: string + /** + * Used when calculating the `Expires` `Set-Cookie` attribute of cookies. By default, its value is `10 * 60 * 60 * 1000`. + * Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#cookiemaxage) for details. + */ ttl?: number } +/** + * @interface + * + * HTTP compression configurations. + */ export type HttpCompressionOptions = { + /** + * Whether HTTP compression is enabled. By default, it's `false`. + */ enabled?: boolean + /** + * The level of zlib compression to apply to responses. A higher level will result in better compression but will take longer to complete. + * A lower level will result in less compression but will be much faster. The default value is `6`. + */ level?: number + /** + * How much memory should be allocated to the internal compression state. It's an integer in the range of 1 (minimum level) and 9 (maximum level). + * The default value is `8`. + */ memLevel?: number + /** + * The minimum response body size that compression is applied on. Its value can be the number of bytes or any string accepted by the + * [bytes](https://www.npmjs.com/package/bytes) module. The default value is `1024`. + */ threshold?: number | string } +/** + * @interface + * + * Essential configurations related to the Medusa backend, such as database and CORS configurations. + */ export type ProjectConfigOptions = { - redis_url?: string - redis_prefix?: string - redis_options?: RedisOptions - - session_options?: SessionOptions - - jwt_secret?: string + /** + * The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes. + * + * `store_cors` is a string used to specify the accepted URLs or patterns for store API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins. + * + * Every origin in that list must either be: + * + * 1. A URL. For example, `http://localhost:8000`. The URL must not end with a backslash; + * 2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([\/~@;%#'])(.*?)\1([gimsuy]*)$`. + * + * @example + * Some example values of common use cases: + * + * ```bash + * # Allow different ports locally starting with 800 + * STORE_CORS=/http:\/\/localhost:800\d+$/ + * + * # Allow any origin ending with vercel.app. For example, storefront.vercel.app + * STORE_CORS=/vercel\.app$/ + * + * # Allow all HTTP requests + * STORE_CORS=/http:\/\/.+/ + * ``` + * + * Then, set the configuration in `medusa-config.js`: + * + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * store_cors: process.env.STORE_CORS, + * // ... + * }, + * // ... + * } + * ``` + * + * If you’re adding the value directly within `medusa-config.js`, make sure to add an extra escaping `/` for every backslash in the pattern. For example: + * + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * store_cors: "/vercel\\.app$/", + * // ... + * }, + * // ... + * } + * ``` + */ + store_cors?: string + /** + * The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes. + * + * `admin_cors` is a string used to specify the accepted URLs or patterns for admin API Routes. It can either be one accepted origin, or a comma-separated list of accepted origins. + * + * Every origin in that list must either be: + * + * 1. A URL. For example, `http://localhost:7001`. The URL must not end with a backslash; + * 2. Or a regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([\/~@;%#'])(.*?)\1([gimsuy]*)$`. + * + * @example + * Some example values of common use cases: + * + * ```bash + * # Allow different ports locally starting with 700 + * ADMIN_CORS=/http:\/\/localhost:700\d+$/ + * + * # Allow any origin ending with vercel.app. For example, admin.vercel.app + * ADMIN_CORS=/vercel\.app$/ + * + * # Allow all HTTP requests + * ADMIN_CORS=/http:\/\/.+/ + * ``` + * + * Then, set the configuration in `medusa-config.js`: + * + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * admin_cors: process.env.ADMIN_CORS, + * // ... + * }, + * // ... + * } + * ``` + * + * If you’re adding the value directly within `medusa-config.js`, make sure to add an extra escaping `/` for every backslash in the pattern. For example: + * + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * admin_cors: "/http:\\/\\/localhost:700\\d+$/", + * // ... + * }, + * // ... + * } + * ``` + */ + admin_cors?: string + /** + * A random string used to create cookie tokens. Although this configuration option is not required, it’s highly recommended to set it for better security. + * + * In a development environment, if this option is not set, the default secret is `supersecret` However, in production, if this configuration is not set, an error is thrown and + * the backend crashes. + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * cookie_secret: process.env.COOKIE_SECRET || + * "supersecret", + * // ... + * }, + * // ... + * } + * ``` + */ cookie_secret?: string - database_url?: string + /** + * A random string used to create authentication tokens. Although this configuration option is not required, it’s highly recommended to set it for better security. + * + * In a development environment, if this option is not set the default secret is `supersecret` However, in production, if this configuration is not set an error, an + * error is thrown and the backend crashes. + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * jwt_secret: process.env.JWT_SECRET || + * "supersecret", + * // ... + * }, + * // ... + * } + * ``` + */ + jwt_secret?: string + + /** + * The name of the database to connect to. If specified in `database_url`, then it’s not required to include it. + * + * Make sure to create the PostgreSQL database before using it. You can check how to create a database in + * [PostgreSQL's documentation](https://www.postgresql.org/docs/current/sql-createdatabase.html). + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * database_database: process.env.DATABASE_DATABASE || + * "medusa-store", + * // ... + * }, + * // ... + * } + * ``` + */ database_database?: string + + /** + * The connection URL of the database. The format of the connection URL for PostgreSQL is: + * + * ```bash + * postgres://[user][:password]@[host][:port]/[dbname] + * ``` + * + * Where: + * + * - `[user]`: (required) your PostgreSQL username. If not specified, the system's username is used by default. The database user that you use must have create privileges. If you're using the `postgres` superuser, then it should have these privileges by default. Otherwise, make sure to grant your user create privileges. You can learn how to do that in [PostgreSQL's documentation](https://www.postgresql.org/docs/current/ddl-priv.html). + * - `[:password]`: an optional password for the user. When provided, make sure to put `:` before the password. + * - `[host]`: (required) your PostgreSQL host. When run locally, it should be `localhost`. + * - `[:post]`: an optional port that the PostgreSQL server is listening on. By default, it's `5432`. When provided, make sure to put `:` before the port. + * - `[dbname]`: (required) the name of the database. + * + * You can learn more about the connection URL format in [PostgreSQL’s documentation](https://www.postgresql.org/docs/current/libpq-connect.html). + * + * @example + * For example, set the following database URL in your environment variables: + * + * ```bash + * DATABASE_URL=postgres://postgres@localhost/medusa-store + * ``` + * + * Then, use the value in `medusa-config.js`: + * + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * database_url: process.env.DATABASE_URL, + * // ... + * }, + * // ... + * } + * ``` + */ + database_url?: string + /** + * The database schema to connect to. This is not required to provide if you’re using the default schema, which is `public`. + * + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * database_schema: process.env.DATABASE_SCHEMA || + * "custom", + * // ... + * }, + * // ... + * } + * ``` + */ database_schema?: string + + /** + * This configuration specifies what database messages to log. Its value can be one of the following: + * + * - (default) A boolean value that indicates whether any messages should be logged. + * - The string value `all` that indicates all types of messages should be logged. + * - An array of log-level strings to indicate which type of messages to show in the logs. The strings can be `query`, `schema`, `error`, `warn`, `info`, `log`, or `migration`. Refer to [Typeorm’s documentation](https://typeorm.io/logging#logging-options) for more details on what each of these values means. + * + * If this configuration isn't set, its default value is `false`, meaning no database messages are logged. + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * database_logging: [ + * "query", "error", + * ], + * // ... + * }, + * // ... + * } + * ``` + */ database_logging: LoggerOptions - // @deprecated - only postgres is supported, so this config has no effect + /** + * @ignore + * @deprecated + * + * @privateRemark + * only postgres is supported, so this config has no effect + */ database_type?: string - http_compression?: HttpCompressionOptions - + /** + * An object that includes additional configurations to pass to the database connection. You can pass any configuration. One defined configuration to pass is + * `ssl` which enables support for TLS/SSL connections. + * + * This is useful for production databases, which can be supported by setting the `rejectUnauthorized` attribute of `ssl` object to `false`. + * During development, it’s recommended not to pass this option. + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * database_extra: + * process.env.NODE_ENV !== "development" + * ? { ssl: { rejectUnauthorized: false } } + * : {}, + * // ... + * }, + * // ... + * } + * ``` + */ database_extra?: Record & { - ssl: { rejectUnauthorized: false } + /** + * Configure support for TLS/SSL connection + */ + ssl: { + /** + * Whether to fail connection if the server certificate is verified against the list of supplied CAs and the hostname and no match is found. + */ + rejectUnauthorized: false + } } - store_cors?: string - admin_cors?: string + + /** + * Used to specify the URL to connect to Redis. This is only used for scheduled jobs. If you omit this configuration, scheduled jobs won't work. + * + * :::note + * + * You must first have Redis installed. You can refer to [Redis's installation guide](https://redis.io/docs/getting-started/installation/). + * + * ::: + * + * The Redis connection URL has the following format: + * + * ```bash + * redis[s]://[[username][:password]@][host][:port][/db-number] + * ``` + * + * For a local Redis installation, the connection URL should be `redis://localhost:6379` unless you’ve made any changes to the Redis configuration during installation. + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * redis_url: process.env.REDIS_URL || + * "redis://localhost:6379", + * // ... + * }, + * // ... + * } + * ``` + */ + redis_url?: string + + /** + * The prefix set on all keys stored in Redis. The default value is `sess:`. + * + * If this configuration option is provided, it is prepended to `sess:`. + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * redis_prefix: process.env.REDIS_PREFIX || + * "medusa:", + * // ... + * }, + * // ... + * } + * ``` + */ + redis_prefix?: string + + /** + * An object of options to pass ioredis. You can refer to [ioredis’s RedisOptions documentation](https://redis.github.io/ioredis/index.html#RedisOptions) + * for the list of available options. + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * redis_options: { + * connectionName: process.env.REDIS_CONNECTION_NAME || + * "medusa", + * }, + * // ... + * }, + * // ... + * } + * ``` + */ + redis_options?: RedisOptions + + /** + * An object of options to pass to [express-session](https://www.npmjs.com/package/express-session). + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * session_options: { + * name: process.env.SESSION_NAME || + * "custom", + * }, + * // ... + * }, + * // ... + * } + * ``` + */ + session_options?: SessionOptions + + /** + * Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there. + * However, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative. + * + * Its value is an object that has the following properties: + * + * If you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `"x-no-compression": true`. + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig: { + * http_compression: { + * enabled: true, + * level: 6, + * memLevel: 8, + * threshold: 1024, + * }, + * // ... + * }, + * // ... + * } + * ``` + */ + http_compression?: HttpCompressionOptions } +/** + * @interface + * + * The configurations for your Medusa backend are in `medusa-config.js` located in the root of your Medusa project. The configurations include database, modules, and plugin configurations, among other configurations. + * + * `medusa-config.js` exports an object having the following properties: + * + * - {@link ConfigModule.projectConfig | projectConfig}: (required): An object that holds general configurations related to the Medusa backend, such as database or CORS configurations. + * - {@link ConfigModule.plugins | plugins}: An array of plugin configurations that defines what plugins are installed and optionally specifies each of their configurations. + * - {@link ConfigModule.modules | modules}: An object that defines what modules are installed and optionally specifies each of their configurations. + * - {@link ConfigModule.featureFlags | featureFlags}: An object that enables or disables features guarded by a feature flag. + * + * For example: + * + * ```js title="medusa-config.js" + * module.exports = { + * projectConfig, + * plugins, + * modules, + * featureFlags, + * } + * ``` + * + * --- + * + * ## Environment Variables + * + * It's highly recommended to store the values of configurations in environment variables, then reference them within `medusa-config.js`. + * + * During development, you can set your environment variables in the `.env` file at the root of your Medusa backend project. In production, + * setting the environment variables depends on the hosting provider. + * + * --- + */ export type ConfigModule = { + /** + * This property holds essential configurations related to the Medusa backend, such as database and CORS configurations. + */ projectConfig: ProjectConfigOptions - featureFlags: Record - modules?: Record< - string, - boolean | Partial - > + + /** + * On your Medusa backend, you can use [Plugins](https://docs.medusajs.com/development/plugins/overview) to add custom features or integrate third-party services. + * For example, installing a plugin to use Stripe as a payment processor. + * + * Aside from installing the plugin with NPM, you need to pass the plugin you installed into the `plugins` array defined in `medusa-config.js`. + * + * The items in the array can either be: + * + * - A string, which is the name of the plugin to add. You can pass a plugin as a string if it doesn’t require any configurations. + * - An object having the following properties: + * - `resolve`: The name of the plugin. + * - `options`: An object that includes the plugin’s options. These options vary for each plugin, and you should refer to the plugin’s documentation for available options. + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * plugins: [ + * `medusa-my-plugin-1`, + * { + * resolve: `medusa-my-plugin`, + * options: { + * apiKey: process.env.MY_API_KEY || + * `test`, + * }, + * }, + * // ... + * ], + * // ... + * } + * ``` + */ plugins: ( | { resolve: string @@ -62,4 +547,77 @@ export type ConfigModule = { } | string )[] + + /** + * In Medusa, commerce and core logic are modularized to allow developers to extend or replace certain [modules](https://docs.medusajs.com/development/modules/overview) + * with custom implementations. + * + * Aside from installing the module with NPM, you must add it to the exported object in `medusa-config.js`. + * + * The keys of the `modules` configuration object refer to the type of module. Its value can be one of the following: + * + * 1. A boolean value indicating whether the module type is enabled; + * 2. Or a string value indicating the name of the module to be used for the module type. This can be used if the module does not require any options; + * 3. Or an object having the following properties, but typically you would mainly use the `resolve` and `options` properties only: + * 1. `resolve`: a string indicating the name of the module. + * 2. `options`: an object indicating the options to pass to the module. These options vary for each module, and you should refer to the module’s documentation for details on them. + * 3. `resources`: a string indicating whether the module shares the dependency container with the Medusa core. Its value can either be `shared` or `isolated`. Refer to the [Modules documentation](https://docs.medusajs.com/development/modules/create#module-scope) for more details. + * 4. `alias`: a string indicating a unique alias to register the module under. Other modules can’t use the same alias. + * 5. `main`: a boolean value indicating whether this module is the main registered module. This is useful when an alias is used. + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * modules: { + * eventBus: { + * resolve: "@medusajs/event-bus-local", + * }, + * cacheService: { + * resolve: "@medusajs/cache-redis", + * options: { + * redisUrl: process.env.CACHE_REDIS_URL, + * ttl: 30, + * }, + * }, + * // ... + * }, + * // ... + * } + * ``` + */ + modules?: Record< + string, + boolean | Partial + > + + /** + * Some features in the Medusa backend are guarded by a feature flag. This ensures constant shipping of new features while maintaining the engine’s stability. + * + * You can specify whether a feature should or shouldn’t be used in your backend by enabling its feature flag. Feature flags can be enabled through either environment + * variables or through this configuration exported in `medusa-config.js`. + * + * If you want to use the environment variables method, learn more about it in the [Feature Flags documentation](https://docs.medusajs.com/development/feature-flags/toggle#method-one-using-environment-variables). + * + * The `featureFlags` configuration is an object. Its properties are the names of the feature flags. Each property’s value is a boolean indicating whether the feature flag is enabled. + * + * You can find available feature flags and their key name [here](https://github.com/medusajs/medusa/tree/master/packages/medusa/src/loaders/feature-flags). + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * featureFlags: { + * product_categories: true, + * // ... + * }, + * // ... + * } + * ``` + * + * :::note + * + * After enabling a feature flag, make sure to [run migrations](https://docs.medusajs.com/development/entities/migrations/overview#migrate-command) as it may require making changes to the database. + * + * ::: + */ + featureFlags: Record } diff --git a/packages/types/src/common/medusa-container.ts b/packages/types/src/common/medusa-container.ts index c3a8fc19e2..4acf0d1594 100644 --- a/packages/types/src/common/medusa-container.ts +++ b/packages/types/src/common/medusa-container.ts @@ -1,7 +1,17 @@ import { AwilixContainer } from "awilix" +/** + * The Medusa Container extends [Awilix](https://github.com/jeffijoe/awilix) to + * provide dependency injection functionalities. + */ export type MedusaContainer = AwilixContainer & { + /** + * @ignore + */ registerAdd: (name: string, registration: T) => MedusaContainer + /** + * @ignore + */ createScope: () => MedusaContainer } diff --git a/packages/types/src/file-service/index.ts b/packages/types/src/file-service/index.ts index 42ae41d765..45ae59be49 100644 --- a/packages/types/src/file-service/index.ts +++ b/packages/types/src/file-service/index.ts @@ -1,32 +1,95 @@ import stream from "stream" +/** + * @interface + * + * Details of a file upload's result. + */ export type FileServiceUploadResult = { + /** + * The file's URL. + */ url: string + /** + * The file's key. This key is used in other operations, + * such as deleting a file. + */ key: string } +/** + * @interface + * + * The relevant details to upload a file through a stream. + */ export type FileServiceGetUploadStreamResult = { + /** + * A [PassThrough](https://nodejs.org/api/stream.html#class-streampassthrough) write stream object to be used to write the file. + */ writeStream: stream.PassThrough + /** + * A promise that should resolved when the writing process is done to finish the upload. + */ promise: Promise + /** + * The URL of the file once it’s uploaded. + */ url: string + /** + * The identifier of the file in the storage. For example, for a local file service, this can be the file's name. + */ fileKey: string [x: string]: unknown } +/** + * @interface + * + * The details of a file to retrieve. + */ export type GetUploadedFileType = { + /** + * The file's key. + */ fileKey: string + /** + * Whether the file is private. + */ isPrivate?: boolean [x: string]: unknown } +/** + * @interface + * + * The details of the file to remove. + */ export type DeleteFileType = { + /** + * The file's key. When uploading a file, the + * returned key is used here. + */ fileKey: string [x: string]: unknown } +/** + * @interface + * + * The details of the file being uploaded through a stream. + */ export type UploadStreamDescriptorType = { + /** + * The name of the file. + */ name: string + /** + * The extension of the file. + */ ext?: string + /** + * Whether the file should be uploaded to a private bucket or location. By convention, the default value of this property is `true`. + */ isPrivate?: boolean [x: string]: unknown } diff --git a/packages/utils/src/search/abstract-service.ts b/packages/utils/src/search/abstract-service.ts index 0ab9628f32..87600b717b 100644 --- a/packages/utils/src/search/abstract-service.ts +++ b/packages/utils/src/search/abstract-service.ts @@ -1,53 +1,380 @@ import { SearchTypes } from "@medusajs/types" +/** + * ## Overview + * + * A search service class is in a TypeScript or JavaScript file created in the `src/services` directory. The class must extend the `AbstractSearchService` class imported + * from the `@medusajs/utils` package. + * + * Based on services’ naming conventions, the file’s name should be the slug version of the search service’s name without `service`, and the class’s name should be the + * pascal case of the search service’s name following by `Service`. + * + * For example, create the `MySearchService` class in the file `src/services/my-search.ts`: + * + * ```ts title="src/services/my-search.ts" + * import { AbstractSearchService } from "@medusajs/utils" + * + * class MySearchService extends AbstractSearchService { + * isDefault = false + * + * createIndex(indexName: string, options: Record) { + * throw new Error("Method not implemented.") + * } + * getIndex(indexName: string) { + * throw new Error("Method not implemented.") + * } + * addDocuments( + * indexName: string, + * documents: Record[], + * type: string + * ) { + * throw new Error("Method not implemented.") + * } + * replaceDocuments( + * indexName: string, + * documents: Record[], + * type: string + * ) { + * throw new Error("Method not implemented.") + * } + * deleteDocument( + * indexName: string, + * document_id: string | number + * ) { + * throw new Error("Method not implemented.") + * } + * deleteAllDocuments(indexName: string) { + * throw new Error("Method not implemented.") + * } + * search( + * indexName: string, + * query: string, + * options: Record + * ) { + * return { + * message: "test", + * } + * } + * updateSettings( + * indexName: string, + * settings: Record + * ) { + * throw new Error("Method not implemented.") + * } + * + * } + * + * export default MySearchService + * ``` + * + * --- + * + * ## Notes About Class Methods + * + * Although there are several helper methods in this class, the main methods used by the Medusa backend are `addDocuments`, `deleteDocument`, and `search`. + * The rest of the methods are provided in case you need them for custom use cases. + * + * --- + */ export abstract class AbstractSearchService implements SearchTypes.ISearchService { + /** + * @ignore + */ static _isSearchService = true + /** + * @ignore + */ static isSearchService(obj) { return obj?.constructor?._isSearchService } + /** + * This property is used to pinpoint the default search service defined in the Medusa core. For custom search services, the `isDefault` property must be `false`. + */ abstract readonly isDefault + /** + * If your search service is created in a plugin, the plugin's options will be available in this property. + */ protected readonly options_: Record + /** + * @ignore + */ get options(): Record { return this.options_ } + /** + * You can use the `constructor` of your search service to access the different services in Medusa through dependency injection. + * + * You can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, + * you can initialize it in the constructor and use it in other methods in the service. + * + * Additionally, if you’re creating your search service as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, + * you can access them in the constructor. The default constructor already sets the value of the class proeprty `options_` to the passed options. + * + * @param {MedusaContainer} container - An instance of `MedusaContainer` that allows you to access other resources, such as services, in your Medusa backend. + * @param {Record} options - If this search service is created in a plugin, the plugin's options are passed in this parameter. + * + * @example + * // ... + * import { ProductService } from "@medusajs/medusa" + * + * type InjectedDependencies = { + * productService: ProductService + * } + * + * class MySearchService extends AbstractSearchService { + * // ... + * protected readonly productService_: ProductService + * + * constructor({ productService }: InjectedDependencies) { + * // @ts-expect-error prefer-rest-params + * super(...arguments) + * this.productService_ = productService + * + * // you can also initialize a client that + * // communicates with a third-party service. + * this.client = new Client(options) + * } + * + * // ... + * } + */ protected constructor(container, options) { this.options_ = options } + /** + * This method is used to create an index in the search engine. + * + * @param {string} indexName - The name of the index to create. + * @param {unknown} options - Any options that may be relevant to your search service. This parameter doesn't have + * any defined format as it depends on your custom implementation. + * @returns {unknown} No required format of returned data, as it depends on your custom implementation. + * + * @example + * An example implementation, assuming `client` would interact with a third-party service: + * + * ```ts title="src/services/my-search.ts" + * class MySearchService extends AbstractSearchService { + * // ... + * createIndex(indexName: string, options: Record) { + * return this.client_.initIndex(indexName) + * } + * // ... + * } + * ``` + * + * Another example of how the [MeiliSearch plugin](https://docs.medusajs.com/plugins/search/meilisearch) uses the + * `options` parameter: + * + * ```ts + * class MeiliSearchService extends AbstractSearchService { + * // ... + * async createIndex( + * indexName: string, + * options: Record = { primaryKey: "id" } + * ) { + * return await this.client_.createIndex(indexName, options) + * } + * // ... + * } + * ``` + */ abstract createIndex(indexName: string, options: unknown): unknown + /** + * This method is used to retrieve an index’s results from the search engine. + * + * @param {string} indexName - The name of the index + * @returns {unknown} No required format of returned data, as it depends on your custom implementation. + * + * @example + * class MySearchService extends AbstractSearchService { + * // ... + * + * getIndex(indexName: string) { + * return this.client_.getIndex(indexName) + * } + * } + */ abstract getIndex(indexName: string): unknown + /** + * This method is used to add a document to an index in the search engine. + * + * When the Medusa backend loads, it triggers indexing for all products available in the Medusa backend, which uses this method to add or update documents. + * It’s also used whenever a new product is added or a product is updated. + * + * @param {string} indexName - The name of the index to add the documents to. + * @param {unknown} documents - The list of documents to add. For example, an array of {@link entities!Product | products}. + * @param {string} type - The type of documents being indexed. For example, `products`. + * @returns {unknown} The response of saving the documents in the search engine, but there’s no required format of the response. + * + * @example + * class MySearchService extends AbstractSearchService { + * // ... + * + * async addDocuments( + * indexName: string, + * documents: Record[], + * type: string + * ) { + * return await this.client_ + * .addDocuments(indexName, documents) + * } + * } + */ abstract addDocuments( indexName: string, documents: unknown, type: string ): unknown + /** + * This method is used to replace existing documents in the search engine of an index with new documents. + * + * @param {string} indexName - The name of the index that the documents belong to. + * @param {unknown} documents - The list of documents to index. For example, it can be an array of {@link entities!Product | products}. + * Based on your search engine implementation, the documents should include an identification key that allows replacing the existing documents. + * @param {string} type - The type of documents being replaced. For example, `products`. + * @returns {unknown} The response of replacing the documents in the search engine, but there’s no required format of the response. + * + * @example + * class MySearchService extends AbstractSearchService { + * // ... + * + * async replaceDocuments( + * indexName: string, + * documents: Record[], + * type: string + * ) { + * await this.client_ + * .removeDocuments(indexName) + * return await this.client_ + * .addDocuments(indexName, documents) + * } + * } + */ abstract replaceDocuments( indexName: string, documents: unknown, type: string ): unknown + /** + * This method is used to delete a document from an index. + * + * When a product is deleted in the Medusa backend, this method is used to delete the product from the search engine’s index. + * + * @param {string} indexName - The name of the index that the document belongs to. + * @param {string | number} document_id - The ID of the item indexed. For example, if the deleted item is a product, then this is + * the ID of the product. + * @returns {unknown} The response of deleting the document in the search engine, but there’s no required format of the response. + * + * @example + * class MySearchService extends AbstractSearchService { + * // ... + * + * async deleteDocument( + * indexName: string, + * document_id: string | number + * ) { + * return await this.client_ + * .deleteDocument(indexName, document_id) + * } + * } + */ abstract deleteDocument( indexName: string, document_id: string | number ): unknown + /** + * This method is used to delete all documents from an index. + * + * @param {string} indexName - The index's name. + * @returns {unknown} The response of deleting the documents of that index in the search engine, but there’s no required format of the response. + * + * @example + * class MySearchService extends AbstractSearchService { + * // ... + * + * async deleteAllDocuments(indexName: string) { + * return await this.client_ + * .deleteDocuments(indexName) + * } + * } + */ abstract deleteAllDocuments(indexName: string): unknown + /** + * This method is used to search through an index by a query. + * + * In the Medusa backend, this method is used within the [Search Products API Route](https://docs.medusajs.com/api/store#products_postproductssearch) + * to retrieve the search results. The API route's response type is an array of items, though the item's format is not defined as it depends on the + * data returned by this method. + * + * @param {string} indexName - The index's name. In the case of the Search Products API Routes, its value is `products`. + * @param {string | null} query - The search query to retrieve results for. + * @param {unknown} options - + * Options that can configure the search process. The Search Products API route passes an object having the properties: + * + * - `paginationOptions`: An object having an `offset` and `limit` properties, which are passed in the API Route's body. + * - `filter`: Filters that are passed in the API Route's request body. Its format is unknown, so you can pass filters based on your search service. + * - `additionalOptions`: Any other parameters that may be passed in the request's body. + * + * @returns {unknown} The list of results. For example, an array of products. + * + * @example + * class MySearchService extends AbstractSearchService { + * // ... + * + * async search( + * indexName: string, + * query: string, + * options: Record + * ) { + * const hits = await this.client_ + * .search(indexName, query) + * return { + * hits, + * } + * } + * } + */ abstract search( indexName: string, query: string | null, options: unknown ): unknown + /** + * This method is used to update the settings of an index within the search service. This is useful if you want to update the index settings when the plugin options change. + * + * For example, in the Algolia plugin, a loader, which runs when the Medusa backend loads, is used to update the settings of indices based on the plugin options. + * The loader uses this method to update the settings. + * + * @param {string} indexName - The index's name to update its settings. + * @param {unknown} settings - The settings to update. Its format depends on your use case. + * @returns {unknown} The response of updating the index in the search engine, but there’s no required format of the response. + * + * @example + * class MySearchService extends AbstractSearchService { + * // ... + * + * async updateSettings( + * indexName: string, + * settings: Record + * ) { + * return await this.client_ + * .updateSettings(indexName, settings) + * } + * } + */ abstract updateSettings(indexName: string, settings: unknown): unknown } diff --git a/www/apps/docs/content/cli/reference.mdx b/www/apps/docs/content/cli/reference.mdx index 34d2c94a1e..c91131b9fb 100644 --- a/www/apps/docs/content/cli/reference.mdx +++ b/www/apps/docs/content/cli/reference.mdx @@ -246,5 +246,5 @@ medusa telemetry ## See Also -- [Configure Medusa](../development/backend/configurations.md) +- [Configure Medusa](../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx) - [Set up your development environment](../development/backend/prepare-environment.mdx) diff --git a/www/apps/docs/content/deployments/server/deploying-on-digital-ocean.md b/www/apps/docs/content/deployments/server/deploying-on-digital-ocean.md index b6e0071504..b04e43af9c 100644 --- a/www/apps/docs/content/deployments/server/deploying-on-digital-ocean.md +++ b/www/apps/docs/content/deployments/server/deploying-on-digital-ocean.md @@ -15,7 +15,7 @@ DigitalOcean is a reliable hosting provider that provides different ways to host It is assumed that you already have a Medusa backend installed locally. If you don’t, please follow the [quickstart guide](../../create-medusa-app.mdx). -Furthermore, your Medusa backend should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Backend documentation](../../development/backend/configurations.md) to learn how to do that. +Furthermore, your Medusa backend should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Backend documentation](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx) to learn how to do that. ### Needed Accounts diff --git a/www/apps/docs/content/deployments/server/deploying-on-heroku.mdx b/www/apps/docs/content/deployments/server/deploying-on-heroku.mdx index d2ac51c04e..4b820e83af 100644 --- a/www/apps/docs/content/deployments/server/deploying-on-heroku.mdx +++ b/www/apps/docs/content/deployments/server/deploying-on-heroku.mdx @@ -19,7 +19,7 @@ Alternatively, you can use this button to deploy the Medusa backend to Heroku di It is assumed that you already have a Medusa backend installed locally. If you don’t, please follow the [quickstart guide](../../development/backend/install.mdx). -Furthermore, your Medusa backend should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Backend documentation](../../development/backend/configurations.md) to learn how to do that. +Furthermore, your Medusa backend should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Backend documentation](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx) to learn how to do that. ### Needed Accounts @@ -87,7 +87,7 @@ This uses the lowest plan in Stackhero Redis. You can check out [the plans and p ### 4. Configure Environment Variables on Heroku -Medusa requires a set of environment variables to be configured. You can learn more about Medusa's configurations in the [Configure your Medusa backend](../../development/backend/configurations.md) document. +Medusa requires a set of environment variables to be configured. You can learn more about Medusa's configurations in the [Configure your Medusa backend](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx) document. Run the following commands in the root directory of your Medusa backend to set some environment variables: diff --git a/www/apps/docs/content/deployments/server/deploying-on-microtica.md b/www/apps/docs/content/deployments/server/deploying-on-microtica.md index 43bceaf406..08f9a0bb29 100644 --- a/www/apps/docs/content/deployments/server/deploying-on-microtica.md +++ b/www/apps/docs/content/deployments/server/deploying-on-microtica.md @@ -50,7 +50,7 @@ Since Microtica deploys on your cloud account, here are the resources that the p It is assumed that you already have a Medusa backend installed locally. If you don’t, please follow the [quickstart guide](../../development/backend/install.mdx). -Furthermore, your Medusa backend should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Backend documentation](../../development/backend/configurations.md) to learn how to do that. +Furthermore, your Medusa backend should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Backend documentation](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx) to learn how to do that. ### Needed Accounts diff --git a/www/apps/docs/content/deployments/server/deploying-on-railway.md b/www/apps/docs/content/deployments/server/deploying-on-railway.md index 33b9f50220..59630b05fc 100644 --- a/www/apps/docs/content/deployments/server/deploying-on-railway.md +++ b/www/apps/docs/content/deployments/server/deploying-on-railway.md @@ -34,7 +34,7 @@ If you also don't have a Medusa project, you can deploy to Railway instantly wit It is assumed that you already have a Medusa backend installed locally. If you don’t, please follow the [quickstart guide](../../development/backend/install.mdx). -Furthermore, your Medusa backend should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Backend documentation](./../../development/backend/configurations.md) to learn how to do that. +Furthermore, your Medusa backend should be configured to work with PostgreSQL and Redis. You can follow the [Configure your Backend documentation](./../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx) to learn how to do that. ### Production Modules diff --git a/www/apps/docs/content/deployments/server/general-guide.md b/www/apps/docs/content/deployments/server/general-guide.md index c1b1c914bd..b9b865b2cb 100644 --- a/www/apps/docs/content/deployments/server/general-guide.md +++ b/www/apps/docs/content/deployments/server/general-guide.md @@ -33,7 +33,7 @@ Make sure the `start` script in your `package.json` runs migrations, the `build` ## Step 3: Set ssl Database Option -In production, it’s recommended to set the [database_extra option](../../development/backend/configurations.md#database_extra) in `medusa-config.js` to disable the `ssl.rejectUnauthorized` option: +In production, it’s recommended to set the [database_extra option](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx#database_extra) in `medusa-config.js` to disable the `ssl.rejectUnauthorized` option: ```jsx title="medusa-config.js" module.exports = { @@ -98,7 +98,7 @@ After you’ve deployed your backend, you can test it out in different ways: ## Set Up CORS Configuration -To connect your storefront and, if deployed separately, your admin dashboard to your deployed Medusa backend, make sure to set up the [admin_cors and store_cors configuration](../../development/backend/configurations.md#admin_cors-and-store_cors) in `medusa-config.js` accordingly. +To connect your storefront and, if deployed separately, your admin dashboard to your deployed Medusa backend, make sure to set up the [admin_cors and store_cors configuration](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx#admin_cors) in `medusa-config.js` accordingly. --- diff --git a/www/apps/docs/content/development/api-routes/create.mdx b/www/apps/docs/content/development/api-routes/create.mdx index 5654548004..16876540c5 100644 --- a/www/apps/docs/content/development/api-routes/create.mdx +++ b/www/apps/docs/content/development/api-routes/create.mdx @@ -115,7 +115,7 @@ For example, if your API route accepts an author ID and a post ID, the path to y ## CORS Configuration -The `cors` middleware, which enables Cross-Origin Resource Sharing (CORS), is automatically applied on custom API Routes defined under the `/store` or `/admin` path prefixes based on the respective [store_cors and admin_cors configurations](../backend/configurations.md#admin_cors-and-store_cors). +The `cors` middleware, which enables Cross-Origin Resource Sharing (CORS), is automatically applied on custom API Routes defined under the `/store` or `/admin` path prefixes based on the respective [store_cors and admin_cors configurations](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx#admin_cors). To add CORS configurations to custom API routes under other path prefixes, or override the CORS configurations added by default, define a [middleware](./add-middleware.mdx) on your API routes and pass it the `cors` middleware. For example: diff --git a/www/apps/docs/content/development/backend/configurations.md b/www/apps/docs/content/development/backend/configurations.md deleted file mode 100644 index f7364e14e1..0000000000 --- a/www/apps/docs/content/development/backend/configurations.md +++ /dev/null @@ -1,476 +0,0 @@ ---- -description: 'Learn about the different configurations available in a Medusa backend. This includes configurations related to the database, CORS, plugins, and more.' ---- - -# Configure Medusa Backend - -This document provides a reference of all accepted Medusa configurations in `medusa-config.js`. - -## Prerequisites - -This document assumes you already followed along with the [Prepare Environment documentation](./prepare-environment.mdx) and have [installed a Medusa backend](./install.mdx#create-a-medusa-backend). - ---- - -## Medusa Configurations File - -The configurations for your Medusa backend are in `medusa-config.js` located in the root of your Medusa project. The configurations include database, modules, and plugin configurations, among other configurations. - -`medusa-config.js` exports an object having the following properties: - -| Property Name | Description | Required | -| --- | --- | --- | -| [projectConfig](#projectconfig) | An object that holds general configurations related to the Medusa backend, such as database or CORS configurations. | Yes | -| [plugins](#plugins) | An array of plugin configurations that defines what plugins are installed and optionally specifies each of their configurations. | No | -| [modules](#modules) | An object that defines what modules are installed and optionally specifies each of their configurations. | No | -| [featureFlags](#featureflags) | An object that enables or disables features guarded by a feature flag. | No | - -For example: - -```js title="medusa-config.js" -module.exports = { - projectConfig, - plugins, - modules, - featureFlags, -} -``` - ---- - -## Environment Variables - -Many of the configurations mentioned in this guide are recommended to have their values set in environment variables and referenced within `medusa-config.js`. - -During development, you can set your environment variables in the `.env` file at the root of your Medusa backend project. In production, setting the environment variables depends on the hosting provider. - ---- - -## projectConfig - -This section includes all configurations that belong to the `projectConfig` property in the configuration object exported by `medusa-config.js`. The `projectConfig` property is an object, and each of the configurations in this section is added to this object as key-value pairs. - -### admin_cors and store_cors - -The Medusa backend’s API Routes are protected by Cross-Origin Resource Sharing (CORS). So, only allowed URLs or URLs matching a specified pattern can send requests to the backend’s API Routes. - -`admin_cors` is used to specify the accepted URLs or patterns for admin API Routes, and `store_cors` is used to specify the accepted URLs or patterns for store API Routes. - -For both the `admin_cors` and `store_cors`, the value is expected to be a string. This string can be a comma-separated list of accepted origins. Every origin in that list can be of the following types: - -1. A URL. For example, `http://localhost:8000`. The URL shouldn’t end with a backslash. -2. A regular expression pattern that can match more than one origin. For example, `.example.com`. The regex pattern that the backend tests for is `^([\/~@;%#'])(.*?)\1([gimsuy]*)$`. - -Here are some examples of common use cases: - -```bash -# Allow different ports locally starting with 700 -ADMIN_CORS=/http:\/\/localhost:700\d+$/ - -# Allow any origin ending with vercel.app. For example, storefront.vercel.app -STORE_CORS=/vercel\.app$/ - -# Allow all HTTP requests -ADMIN_CORS=/http:\/\/*/ -``` - -Typically, the value of these configurations would be set in an environment variable and referenced in `medusa-config.js`: - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - admin_cors: process.env.ADMIN_CORS, - store_cors: process.env.STORE_CORS, - // ... - }, - // ... -} -``` - -If you’re adding the value directly within `medusa-config.js`, make sure to add an extra escaping `/` for every backslash in the pattern. For example: - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - admin_cors: "/http:\\/\\/localhost:700\\d+$/", - store_cors: "/vercel\\.app$/", - // ... - }, - // ... -} -``` - -### cookie_secret - -A string that is used to create cookie tokens. Although this configuration option is not required, it’s highly recommended to set it for better security. It’s also recommended to generate a random string. - -In a development environment, if this option is not set the default secret is `supersecret` However, in production, if this configuration is not set an error will be thrown and your backend will crash. - -Typically, the value of this configuration would be set in an environment variable and referenced in `medusa-config.js`. - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - cookie_secret: process.env.COOKIE_SECRET, - // ... - }, - // ... -} -``` - -### http_compression - -This configuration enables HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there. However, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative. - -Its value is an object that has the following properties: - -- `enabled`: A boolean flag that indicates whether HTTP compression is enabled. It is disabled by default. -- `level`: A `number` value that indicates the level of zlib compression to apply to responses. A higher level will result in better compression but will take longer to complete. A lower level will result in less compression but will be much faster. The default value is 6. -- `memLevel`: A `number` value that specifies how much memory should be allocated to the internal compression state. It's an integer in the range of 1 (minimum level) and 9 (maximum level). The default value is `8`. -- `threshold`: A `number` or a `string` value in bytes that specifies the minimum response body size that compression is applied on. This is the number of bytes or any string accepted by the bytes module. The default value is `1024`. - -If you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `"x-no-compression": true`. - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - http_compression: { - enabled: true, - level: 6, - memLevel: 8, - threshold: 1024, - }, - // ... - }, - // ... -} -``` - -### jwt_secret - -A string that is used to create authentication tokens. Although this configuration option is not required, it’s highly recommended to set it for better security. It’s also recommended to generate a random string. - -In a development environment, if this option is not set the default secret is `supersecret` However, in production, if this configuration is not set an error will be thrown and your backend will crash. - -Typically, the value of this configuration would be set in an environment variable and referenced in `medusa-config.js`. - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - jwt_secret: process.env.JWT_SECRET, - // ... - }, - // ... -} -``` - -### database_database - -The name of the database to connect to. If provided in `database_url`, then it’s not necessary to include it. - -Make sure to create the PostgreSQL database before using it. You can check how to create a database in [PostgreSQL's documentation](https://www.postgresql.org/docs/current/sql-createdatabase.html). - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - database_database: "medusa-store", - // ... - }, - // ... -} -``` - -### database_extra - -An object that includes additional configurations to pass to the database connection. You can pass any configuration. One defined configuration to pass is `ssl` which enables support for TLS/SSL connections. - -This is useful for production databases, which can be supported by setting the `rejectUnauthorized` attribute of `ssl` object to `false`. During development, it’s recommended not to pass this option. - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - database_extra: - process.env.NODE_ENV !== "development" - ? { ssl: { rejectUnauthorized: false } } - : {}, - // ... - }, - // ... -} -``` - -### database_logging - -This configuration specifies what messages to log. Its value can be one of the following: - -- (default) A boolean value that indicates whether any messages should be logged or not. By default, if no value is provided, the value will be `false`. -- The string value `all` that indicates all types of messages should be logged. -- An array of log-level strings to indicate which type of messages to show in the logs. The strings can be `query`, `schema`, `error`, `warn`, `info`, `log`, or `migration`. Refer to [Typeorm’s documentation](https://typeorm.io/logging#logging-options) for more details on what each of these values means. - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - database_logging: [ - "query", "error", - ], - // ... - }, - // ... -} -``` - -### database_schema - -A string indicating the database schema to connect to. This is not necessary to provide if you’re using the default schema, which is `public`. - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - database_schema: "custom", - // ... - }, - // ... -} -``` - -### database_type - -A string indicating the type of database to connect to. At the moment, only `postgres` is accepted, which is also the default value. - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - database_type: "postgres", - // ... - }, - // ... -} -``` - -### database_url - -A string indicating the connection URL of the database. Typically, the connection URL would be set in an environment variable, and the variable would be referenced in `medusa-config.js`. - -The format of the connection URL for PostgreSQL is: - -```bash -postgres://[user][:password]@[host][:port]/[dbname] -``` - -Where: - -- `[user]`: (required) your PostgreSQL username. If not specified, the system's username is used by default. The database user that you use must have create privileges. If you're using the `postgres` superuser, then it should have these privileges by default. Otherwise, make sure to grant your user create privileges. You can learn how to do that in [PostgreSQL's documentation](https://www.postgresql.org/docs/current/ddl-priv.html). -- `[:password]`: an optional password for the user. When provided, make sure to put `:` before the password. -- `[host]`: (required) your PostgreSQL host. When run locally, it should be `localhost`. -- `[:post]`: an optional port that the PostgreSQL server is listening on. By default, it's `5432`. When provided, make sure to put `:` before the port. -- `[dbname]`: (required) the name of the database. - -For example, you can set the following database URL in your environment variables: - -```bash -DATABASE_URL=postgres://postgres@localhost/medusa-store -``` - -You can learn more about the connection URL format in [PostgreSQL’s documentation](https://www.postgresql.org/docs/current/libpq-connect.html). - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - database_url: process.env.DATABASE_URL, - // ... - }, - // ... -} -``` - -### redis_url - -This configuration is used to specify the URL to connect to Redis. This is only used for scheduled jobs. If you omit this configuration, scheduled jobs will not work. - -:::note - -You must first have Redis installed. You can refer to [Redis's installation guide](https://redis.io/docs/getting-started/installation/). - -::: - -The Redis connection URL has the following format: - -```bash -redis[s]://[[username][:password]@][host][:port][/db-number] -``` - -For a local Redis installation, the connection URL should be `redis://localhost:6379` unless you’ve made any changes to the Redis configuration during installation. - -Typically, the value would be added as an environment variable and referenced in `medusa-config.js`. - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - redis_url: process.env.REDIS_URL, - // ... - }, - // ... -} -``` - -### redis_prefix - -The prefix set on all keys stored in Redis. The default value is `sess:`. If this configuration option is provided, it is prepended to `sess:`. - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - redis_prefix: "medusa:", - // ... - }, - // ... -} -``` - -### redis_options - -An object of options to pass ioredis. You can refer to [ioredis’s RedisOptions documentation](https://redis.github.io/ioredis/index.html#RedisOptions) for the list of available options. - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - redis_options: { - connectionName: "medusa", - }, - // ... - }, - // ... -} -``` - -### session_options - -An object of options to pass to `express-session`. The object can have the following properties: - -- `name`: A string indicating the name of the session ID cookie to set in the response (and read from in the request). The default value is `connect.sid`. Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#name) for more details. -- `resave`: A boolean value that indicates whether the session should be saved back to the session store, even if the session was never modified during the request. The default value is `true`. Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#resave) for more details. -- `rolling`: A boolean value that indicates whether the session identifier cookie should be force-set on every response. The default value is `false`. Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#rolling) for more details. -- `saveUninitialized`: A boolean value that indicates whether a session that is "uninitialized" is forced to be saved to the store. The default value is `true`. Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#saveUninitialized) for more details. -- `secret`: A string that indicates the secret to sign the session ID cookie. By default, the value of [cookie_secret](#cookie_secret) will be used. Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#secret) for details. -- `ttl`: A number is used when calculating the `Expires` `Set-Cookie` attribute of cookies. By default, it’ll be `10 * 60 * 60 * 1000`. Refer to [express-session’s documentation](https://www.npmjs.com/package/express-session#cookiemaxage) for details. - -```js title="medusa-config.js" -module.exports = { - projectConfig: { - session_options: { - name: "custom", - }, - // ... - }, - // ... -} -``` - ---- - -## plugins - -On your Medusa backend, you can use Plugins to add custom features or integrate third-party services. For example, installing a plugin to use Stripe as a payment processor. - -Aside from installing the plugin with NPM, you need to pass the plugin you installed into the `plugins` array defined in `medusa-config.js`. - -The items in the array can either be: - -- A string, which is the name of the plugin to add. You can pass a plugin as a string if it doesn’t require any configurations. -- An object having the following properties: - - `resolve`: A string indicating the name of the plugin. - - `options`: An object that includes the plugin’s options. These options vary for each plugin, and you should refer to the plugin’s documentation for details on them. - -For example: - -```js title="medusa-config.js" -module.exports = { - plugins: [ - `medusa-my-plugin-1`, - { - resolve: `medusa-my-plugin`, - options: { - apiKey: `test`, // or use env variables - }, - }, - // ... - ], - // ... -} -``` - -You can refer to the [Plugins Overview documentation](../../plugins/overview.mdx) for a list of available official plugins. - ---- - -## modules - -In Medusa, commerce and core logic are modularized to allow developers to extend or replace certain modules with custom implementations. - -Aside from installing the module with NPM, you need to add it to the exported object in `medusa-config.js`. - -The keys of the `modules` configuration object refer to the type of module. Its value can be one of the following: - -1. A boolean value that indicates whether the module type is enabled. -2. A string value that indicates the name of the module to be used for the module type. This can be used if the module does not require any options. -3. An object having the following properties, but typically you would mainly use the `resolve` and `options` properties only: - 1. `resolve`: a string indicating the name of the module. - 2. `options`: an object indicating the options to pass to the module. These options vary for each module, and you should refer to the module’s documentation for details on them. - 3. `resources`: a string indicating whether the module shares the dependency container with the Medusa core. Its value can either be `shared` or `isolated`. Refer to the [Modules documentation](../modules/create.mdx#module-scope) for more details. - 4. `alias`: a string indicating a unique alias to register the module under. Other modules can’t use the same alias. - 5. `main`: a boolean value indicating whether this module is the main registered module. This is useful when an alias is used. - -For example: - -```js title="medusa-config.js" -module.exports = { - modules: { - eventBus: { - resolve: "@medusajs/event-bus-local", - }, - cacheService: { - resolve: "@medusajs/cache-redis", - options: { - redisUrl: process.env.CACHE_REDIS_URL, - ttl: 30, - }, - }, - // ... - }, - // ... -} -``` - -Learn more about [Modules and how to create and use them](../modules/overview.mdx). - ---- - -## featureFlags - -Some features in the Medusa backend are guarded by a feature flag. This ensures constant shipping of new features while maintaining the engine’s stability. - -You can specify whether a feature should or shouldn’t be used in your backend by enabling its feature flag. Feature flags can be enabled through environment variables or through this configuration exported in `medusa-config.js`. If you want to use the environment variables method, learn more about it in the [Feature Flags documentation](../feature-flags/toggle.md#method-one-using-environment-variables). - -The `featureFlags` configuration is an object. Its properties are the names of the different feature flags. Each property’s value is a boolean indicating whether the feature flag is enabled. - -You can find available feature flags and their key name [here](https://github.com/medusajs/medusa/tree/master/packages/medusa/src/loaders/feature-flags). - -For example: - -```js title="medusa-config.js" -module.exports = { - featureFlags: { - product_categories: true, - // ... - }, - // ... -} -``` - -Learn more about [Feature flags and how to toggle them](../feature-flags/overview.mdx). - -:::note - -After enabling a feature flag, make sure to [run migrations](../entities/migrations/overview.mdx#migrate-command) as it may require making changes to the database. - -::: diff --git a/www/apps/docs/content/development/backend/directory-structure.md b/www/apps/docs/content/development/backend/directory-structure.md index d5339fa3e1..dd39230b3b 100644 --- a/www/apps/docs/content/development/backend/directory-structure.md +++ b/www/apps/docs/content/development/backend/directory-structure.md @@ -40,7 +40,7 @@ Defines an entry file, which is useful when starting the Medusa backend with a p Defines the Medusa backend’s configurations, including the database configurations, plugins used, modules used, and more. -**Read more:** [Medusa backend configurations](./configurations.md). +**Read more:** [Medusa backend configurations](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx). ### package.json diff --git a/www/apps/docs/content/development/backend/install.mdx b/www/apps/docs/content/development/backend/install.mdx index 1a9859d152..e83f74ba06 100644 --- a/www/apps/docs/content/development/backend/install.mdx +++ b/www/apps/docs/content/development/backend/install.mdx @@ -59,7 +59,7 @@ If you run into any errors while installing the CLI tool, check out the [trouble :::warning -If you choose "Skip database setup" you will need to [set the database configurations](./configurations.md#database-configuration) and [run migrations](../entities/migrations/overview.mdx#migrate-command) later. +If you choose "Skip database setup" you will need to [set the database configurations](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx) and [run migrations](../entities/migrations/overview.mdx#migrate-command) later. ::: diff --git a/www/apps/docs/content/development/events/create-subscriber.md b/www/apps/docs/content/development/events/create-subscriber.md index 5ac81c04c6..38b324f5d6 100644 --- a/www/apps/docs/content/development/events/create-subscriber.md +++ b/www/apps/docs/content/development/events/create-subscriber.md @@ -66,7 +66,7 @@ The function accepts a parameter of type `SubscriberArgs`, which has the followi - `data`: The data payload of the emitted event. Its type is different for each event. So, make sure to check the [events reference](./events-list.md) for the expected payload of the events your subscriber listens to. You can then pass the expected payload type as a type parameter to `SubscriberArgs`, for example, `Record`. - `eventName`: A string indicating the name of the event. This is useful if your subscriber listens to more than one event and you want to differentiate between them. - `container`: The [dependency container](../fundamentals/dependency-injection.md) that allows you to resolve Medusa resources, such as services. -- `pluginOptions`: When the subscriber is created within a plugin, this object holds the plugin's options defined in the [Medusa configurations](../backend/configurations.md). +- `pluginOptions`: When the subscriber is created within a plugin, this object holds the plugin's options defined in the [Medusa configurations](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx). --- diff --git a/www/apps/docs/content/development/file-service/create-file-service.md b/www/apps/docs/content/development/file-service/create-file-service.md deleted file mode 100644 index 966f24f2ee..0000000000 --- a/www/apps/docs/content/development/file-service/create-file-service.md +++ /dev/null @@ -1,474 +0,0 @@ ---- -description: "Learn how to create a file service in a Medusa backend or a plugin." ---- - -# How to Create a File Service - -In this document, you’ll learn how to create a file service in Medusa. - -## Overview - -In this guide, you’ll learn about the steps to implement a file service and the methods you’re required to implement in a file service. You can implement the file service within the Medusa backend codebase or in a plugin. - -The file service you’ll be creating in this guide will be a local file service that allows you to upload files into your Medusa backend’s codebase. This is to give you a realistic example of the implementation of a file service. You’re free to implement the file service as required for your case. - ---- - -## Prerequisites - -### (Optional) Multer Types Package - -If you’re using TypeScript, as instructed by this guide, you should install the Multer types package to resolve errors within your file service types. - -To do that, run the following command in the directory of your Medusa backend or plugin: - -```bash npm2yarn -npm install @types/multer -``` - ---- - -## Step 1: Create the File Service Class - -A file service class is defined in a TypeScript or JavaScript file that’s created in the `src/services` directory. The class must extend the `AbstractFileService` class imported from the `@medusajs/medusa` package. - -Based on services’ naming conventions, the file’s name should be the slug version of the file service’s name without `service`, and the class’s name should be the pascal case of the file service’s name following by `Service`. - -For example, if you’re creating a local file service, the file name would be `local-file.ts`, whereas the class name would be `LocalFileService`. - -:::tip - -You can learn more about services and their naming convention in [this documentation](../services/overview.mdx). - -::: - -For example, create the file `src/services/local-file.ts` with the following content: - -```ts title="src/services/local-file.ts" -import { AbstractFileService } from "@medusajs/medusa" -import { - DeleteFileType, - FileServiceGetUploadStreamResult, - FileServiceUploadResult, - GetUploadedFileType, - UploadStreamDescriptorType, -} from "@medusajs/types" - -class LocalFileService extends AbstractFileService { - async upload( - fileData: Express.Multer.File - ): Promise { - throw new Error("Method not implemented.") - } - async uploadProtected( - fileData: Express.Multer.File - ): Promise { - throw new Error("Method not implemented.") - } - async delete(fileData: DeleteFileType): Promise { - throw new Error("Method not implemented.") - } - async getUploadStreamDescriptor( - fileData: UploadStreamDescriptorType - ): Promise { - throw new Error("Method not implemented.") - } - async getDownloadStream( - fileData: GetUploadedFileType - ): Promise { - throw new Error("Method not implemented.") - } - async getPresignedDownloadUrl( - fileData: GetUploadedFileType - ): Promise { - throw new Error("Method not implemented.") - } -} - -export default LocalFileService -``` - -This creates the service `LocalFileService` which, at the moment, adds a general implementation of the methods defined in the abstract class `AbstractFileService`. Notice that the methods' signatures require importing types from the `@medusajs/types` package. - -:::tip - -If you get errors regarding the types not being available in the `@medusajs/types` package, make sure that the latest version of the package is installed: - -```bash npm2yarn -npm install @medusajs/types@latest -``` - -::: - -### Using a Constructor - -You can use a constructor to access services and resources registered in the dependency container, to define any necessary clients if you’re integrating a third-party storage service, and to access plugin options if your file service is defined in a plugin. - -For example, the local service’s constructor could be useful to prepare the local upload directory: - -```ts title="src/services/local-file.ts" -// ... -import * as fs from "fs" - -class LocalFileService extends AbstractFileService { - // can also be replaced by an environment variable - // or a plugin option - protected serverUrl = "http://localhost:9000" - protected publicPath = "uploads" - protected protectedPath = "protected-uploads" - - constructor(container) { - super(container) - - // for public uploads - if (!fs.existsSync(this.publicPath)) { - fs.mkdirSync(this.publicPath) - } - - // for protected uploads - if (!fs.existsSync(this.protectedPath)) { - fs.mkdirSync(this.protectedPath) - } - } - - // ... -} -``` - -Another example showcasing how to access resources using dependency injection: - - - -```ts title="src/services/local-file.ts" -type InjectedDependencies = { - logger: Logger -} - -class LocalFileService extends AbstractFileService { - // ... - protected logger_: Logger - - constructor({ logger }: InjectedDependencies) { - super(...arguments) - this.logger_ = logger - // ... - } - // ... -} -``` - -You can access the plugin options in the second parameter passed to the constructor: - -```ts title="src/services/local-file.ts" -class LocalFileService extends AbstractFileService { - protected serverUrl = "http://localhost:9000" - // ... - - constructor( - container, - pluginOptions - ) { - super(container) - - if (pluginOptions?.serverUrl) { - this.serverUrl = pluginOptions?.serverUrl - } - // ... - } - // ... -} -``` - ---- - -## Step 2: Implement Required Methods - -In this section, you’ll learn about the required methods to implement in the file service. - -### upload - -This method is used to upload a file to the Medusa backend. You must handle the upload logic within this method. - -This method accepts one parameter, which is a [multer file object](http://expressjs.com/en/resources/middleware/multer.html#file-information). The file is uploaded to a temporary directory by default. Among the file’s details, you can access the file’s path in the `path` property of the file object. - -So, for example, you can create a read stream to the file’s content if necessary using the `fs` library: - -```ts -fs.createReadStream(file.path) -``` - -Where `file` is the parameter passed to the `upload` method. - -The method is expected to return an object that has the following properties: - -- `url`: a string indicating the full accessible URL to the file. -- `key`: a string indicating the key used to reference the uploaded file. This is useful when retrieving the file later with other methods like the [getDownloadStream](#getdownloadstream). - -An example implementation of this method for the local file service: - -```ts title="src/services/local-file.ts" -class LocalFileService extends AbstractFileService { - - async upload( - fileData: Express.Multer.File - ): Promise { - const filePath = - `${this.publicPath}/${fileData.originalname}` - fs.copyFileSync(fileData.path, filePath) - return { - url: `${this.serverUrl}/${filePath}`, - key: filePath, - } - } - - // ... -} -``` - -:::tip - -This example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name. - -::: - -### uploadProtected - -This method is used to upload a file to the Medusa backend, but to a protected storage. Typically, this would be used to store files that shouldn’t be accessible by using the file’s URL or should only be accessible by authenticated users. - -You must handle the upload logic and the file permissions or private storage configuration within this method. - -This method accepts one parameter, which is a [multer file object](http://expressjs.com/en/resources/middleware/multer.html#file-information). The file is uploaded to a temporary directory by default. Among the file’s details, you can access the file’s path in the `path` property of the file object. - -So, for example, you can create a read stream to the file’s content if necessary using the `fs` library: - -```ts -fs.createReadStream(file.path) -``` - -Where `file` is the parameter passed to the `uploadProtected` method. - -The method is expected to return an object that has the following properties: - -- `url`: a string indicating the full accessible URL to the file. -- `key`: a string indicating the key used to reference the uploaded file. This is useful when retrieving the file later with other methods like the [getDownloadStream](#getdownloadstream). - -An example implementation of this method for the local file service: - -```ts title="src/services/local-file.ts" -class LocalFileService extends AbstractFileService { - - async uploadProtected( - fileData: Express.Multer.File - ): Promise { - const filePath = - `${this.protectedPath}/${fileData.originalname}` - fs.copyFileSync(fileData.path, filePath) - return { - url: `${this.serverUrl}/${filePath}`, - } - } - - // ... -} -``` - -### delete - -This method is used to delete a file from storage. You must handle the delete logic within this method. - -This method accepts one parameter, which is an object that holds a `fileKey` property. The value of this property is a string that acts as an identifier of the file to delete. Typically, this would be the returned `key` property by other methods, such as the `upload` method. - -For example, for local file service, it could be the file name. - -You can also pass custom properties to the object passed as a first parameter. - -This method is not expected to return anything. - -An example implementation of this method for the local file service: - -```ts title="src/services/local-file.ts" -class LocalFileService extends AbstractFileService { - - async delete( - fileData: DeleteFileType - ): Promise { - fs.rmSync(fileData.fileKey) - } - - // ... -} -``` - -### getUploadStreamDescriptor - -This method is used to upload a file using a write stream. This is useful if the file is being written through a stream rather than uploaded to the temporary directory. - -The method accepts one parameter, which is an object that has the following properties: - -- `name`: a string indicating the name of the file. -- `ext`: an optional string indicating the extension of the file. -- `isPrivate`: an optional boolean value indicating if the file should be uploaded to a private bucket or location. By convention, the default value of this property should be `true` - -The method is expected to return an object having the following properties: - -- `writeStream`: a write stream object. -- `promise`: A promise that should resolved when the writing process is done to finish the upload. This depends on the type of file service you’re creating. -- `url`: a string indicating the URL of the file once it’s uploaded. -- `fileKey`: a string indicating the identifier of your file in the storage. For example, for a local file service this can be the file name. - -You can also return custom properties within the object. - -An example implementation of this method for the local file service: - -```ts title="src/services/local-file.ts" -class LocalFileService extends AbstractFileService { - - async getUploadStreamDescriptor({ - name, - ext, - isPrivate = true, - }: UploadStreamDescriptorType - ): Promise { - const filePath = `${isPrivate ? - this.publicPath : this.protectedPath - }/${name}.${ext}` - const writeStream = fs.createWriteStream(filePath) - - return { - writeStream, - promise: Promise.resolve(), - url: `${this.serverUrl}/${filePath}`, - fileKey: filePath, - } - } - - // ... -} -``` - -### getDownloadStream - -This method is used to read a file using a read stream, typically for download. - -The method accepts as a parameter an object having the following properties: - -- `fileKey`: a string indicating the identifier of the file. This is typically the value returned by other methods like [upload](#upload). -- `isPrivate`: an optional boolean value indicating whether the file should be downloaded from the private bucket or storage location. By convention, this should default to `true`. - -The method is expected to return a readable stream. - -An example implementation of this method for the local file service: - -```ts title="src/services/local-file.ts" -class LocalFileService extends AbstractFileService { - - async getDownloadStream({ - fileKey, - isPrivate = true, - }: GetUploadedFileType - ): Promise { - const filePath = `${isPrivate ? - this.publicPath : this.protectedPath - }/${fileKey}` - const readStream = fs.createReadStream(filePath) - - return readStream - } - - // ... -} -``` - -### getPresignedDownloadUrl - -The `getPresignedDownloadUrl` method is used to retrieve a download URL of the file. For some file services, such as S3, a presigned URL indicates a temporary URL to get access to a file. - -If your file service doesn’t perform or offer a similar functionality, you can just return the URL to download the file. - -The method accepts as a parameter an object having the following properties: - -- `fileKey`: a string indicating the identifier of the file. This is typically the value returned by other methods like [upload](#upload). -- `isPrivate`: an optional boolean value indicating whether the file should be downloaded from the private bucket or storage location. By convention, this should default to `true`. - -The method is expected to return a string, being the URL of the file. - -An example implementation of this method for the local file service: - -```ts title="src/services/local-file.ts" -class LocalFileService extends AbstractFileService { - - async getPresignedDownloadUrl({ - fileKey, - isPrivate = true, - }: GetUploadedFileType - ): Promise { - const filePath = `${isPrivate ? - this.publicPath : this.protectedPath - }/${fileKey}` - return `${this.serverUrl}/${filePath}` - } - - // ... -} -``` - ---- - -## Step 3: Run Build Command - -In the directory of the Medusa backend, run the `build` command to transpile the files in the `src` directory into the `dist` directory: - -```bash npm2yarn -npm run build -``` - ---- - -## Test it Out - -:::note - -This section explains how to test out your implementation if the file service was created in the Medusa backend codebase. You can refer to the [plugin documentation](../plugins/create.mdx#test-your-plugin) on how to test a plugin. - -::: - -Run your backend to test it out: - -```bash npm2yarn -npx medusa develop -``` - -Then, try uploading a file, for example, using the [Upload File API Route](https://docs.medusajs.com/api/admin#uploads_postuploads). The file should be uploaded based on the logic you’ve implemented. - -### (Optional) Accessing the File - -:::note - -This step is only useful if you're implementing a local file service. - -::: - -Since the file is uploaded to a local directory `uploads`, you need to configure a static route in express that allows accessing the files within the `uploads` directory. - -To do that, create the file `src/api/index.ts` with the following content: - -```ts title="src/api/middlewares.ts" -import type { MiddlewaresConfig } from "@medusajs/medusa" -import express from "express" - -export const config: MiddlewaresConfig = { - routes: [ - { - matcher: "/uploads", - middlewares: [express.static(uploadDir)], - }, - ], -} -``` - ---- - -## See Also - -- [How to create a plugin](../plugins/create.mdx) -- [How to publish a plugin](../plugins/publish.mdx) diff --git a/www/apps/docs/content/development/notification/create-notification-provider.md b/www/apps/docs/content/development/notification/create-notification-provider.md deleted file mode 100644 index ebd8d9980d..0000000000 --- a/www/apps/docs/content/development/notification/create-notification-provider.md +++ /dev/null @@ -1,340 +0,0 @@ ---- -description: 'Learn how to create a notification provider in Medusa. This guide explains the different methods available in a Notification provider.' -addHowToData: true ---- - -# How to Create a Notification Provider - -In this document, you’ll learn how to create a Notification Provider in Medusa. - -:::note - -If you’re unfamiliar with the Notification architecture in Medusa, it is recommended to check out the [architecture overview](./overview.mdx) first. - -::: - -## Prerequisites - -Before you start creating a Notification Provider, you need to either install a [Medusa backend](../backend/install.mdx), or create it in a [plugin](../plugins/overview.mdx). The Medusa backend must also have an event bus module installed, which is available when using the default Medusa backend starter. - ---- - -## Create a Notification Provider - -Creating a Notification Provider is as simple as creating a TypeScript or JavaScript file in `src/services`. The name of the file is the name of the provider (for example, `sendgrid.ts`). A Notification Provider is essentially a Service that extends the `AbstractNotificationService` from `@medusajs/medusa`. - -For example, create the file `src/services/email-sender.ts` with the following content: - -```ts title="src/services/email-sender.ts" -import { AbstractNotificationService } from "@medusajs/medusa" -import { EntityManager } from "typeorm" - -class EmailSenderService extends AbstractNotificationService { - protected manager_: EntityManager - protected transactionManager_: EntityManager - - sendNotification( - event: string, - data: unknown, - attachmentGenerator: unknown - ): Promise<{ - to: string; - status: string; - data: Record; - }> { - throw new Error("Method not implemented.") - } - resendNotification( - notification: unknown, - config: unknown, - attachmentGenerator: unknown - ): Promise<{ - to: string; - status: string; - data: Record; - }> { - throw new Error("Method not implemented.") - } - -} - -export default EmailSenderService -``` - -Where `EmailSenderService` is the name of your Notification Provider Service. - -Notification Providers must extend `NotificationService` from `medusa-interfaces`. - -:::info - -Following the naming convention of Services, the name of the file should be the slug name of the Notification Provider, and the name of the class should be the camel case name of the Notification Provider suffixed with “Service”. In the example above, the name of the file should be `email-sender.js`. You can learn more in the [service documentation](../services/create-service.mdx). - -::: - -### identifier - -Notification Provider Services must have a static property `identifier`. - -The `NotificationProvider` entity has 2 properties: `identifier` and `is_installed`. The value of the `identifier` property in the Service class is used when the Notification Provider is created in the database. - -The value of this property is also used later when you want to subscribe the Notification Provider to events in a Loader. - -For example, in the class you created in the previous code snippet you can add the following property: - -```ts -class EmailSenderService extends AbstractNotificationService { - static identifier = "email-sender" - // ... -} -``` - -### constructor - -You can use the `constructor` of your Notification Provider to have access to different Services in Medusa through dependency injection. - -You can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, you can initialize it in the constructor and use it in other methods in the Service. - -Additionally, if you’re creating your Notification Provider as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, you can access it in the constructor. The options are passed as a second parameter. - -:::info - -You can learn more about plugins and how to create them in the [Plugins](../plugins/overview.mdx) documentation. - -::: - -Continuing on with the previous example, if you want to use the [`OrderService`](../../references/services/classes/services.OrderService.mdx) later when sending notifications, you can inject it into the constructor: - -```ts -import { - AbstractNotificationService, - OrderService, -} from "@medusajs/medusa" - -class EmailSenderService extends AbstractNotificationService { - protected manager_: EntityManager - protected transactionManager_: EntityManager - static identifier = "email-sender" - protected orderService: OrderService - - constructor(container, options) { - super(container) - // you can access options here in case you're - // using a plugin - - this.orderService = container.orderService - } - - // ... -} -``` - -### sendNotification - -When an event is triggered that your Notification Provider is registered as a handler for, the [`NotificationService`](../../references/services/classes/services.NotificationService.mdx) in Medusa’s core will execute the `sendNotification` method of your Notification Provider. - -In this method, you can perform the necessary operation to send the Notification. Following the example above, you can send an email to the customer when they place an order. - -This method receives three parameters: - -1. `eventName`: This is the name of the event that was triggered. For example, `order.placed`. -2. `eventData`: This is the data payload of the event that was triggered. For example, if the `order.placed` event is triggered, the `eventData` object contains the property `id` which is the ID of the order that was placed. -3. `attachmentGenerator`: If you’ve previously attached a generator to the `NotificationService` using the [`registerAttachmentGenerator`](../../references/services/classes/services.NotificationService.mdx#registerattachmentgenerator) method, you have access to it here. You can use the `attachmentGenerator` to generate on-demand invoices or other documents. The default value of this parameter is null. - -:::info - -You can learn more about what events are triggered in Medusa and their data payload in the [Events List](../events/events-list.md) documentation. - -::: - -This method must return an object containing two properties: - -1. `to`: a string that represents the receiver of the Notification. For example, if you sent an email to the customer then `to` is the email address of the customer. In other cases, it might be a phone number or a username. -2. `data`: an object that contains the data used to send the Notification. For example, if you sent an order confirmation email to the customer, then the `data` object might include the order items or the subject of the email. This `data` is necessary if the notification is resent later as you can use the same data. - -Continuing with the previous example you can have the following implementation of the `sendNotification` method: - -```ts -class EmailSenderService extends AbstractNotificationService { - // ... - async sendNotification( - event: string, - data: any, - attachmentGenerator: unknown - ): Promise<{ - to: string; - status: string; - data: Record; - }> { - if (event === "order.placed") { - // retrieve order - const order = await this.orderService.retrieve(data.id) - // TODO send email - - console.log("Notification sent") - return { - to: order.email, - status: "done", - data: { - // any data necessary to send the email - // for example: - subject: "You placed a new order!", - items: order.items, - }, - } - } - } -} -``` - -In this code snippet, you check first if the event is `order.placed`. This can be helpful if you’re handling multiple events using the same Notification Provider. - -You then retrieve the order using the ID and send the email. Here, the logic related to sending the email is not implemented as it is generally specific to your Notification Provider. - -Finally, you return an object with the `to` property set to the customer email and the `data` property is an object that contains data necessary to send the email such as a `subject` or `items`. - -:::note - -The `to` and `data` properties are used in the `NotificationService` in Medusa’s core to create a new `Notification` record in the database. You can learn more about the `Notification` entity in the [Architecture Overview](./overview.mdx#notification-entity-overview) documentation. - -::: - -### resendNotification - -Using the [Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend), an admin user can resend a Notification to the customer. The [`NotificationService`](../../references/services/classes/services.NotificationService.mdx) in Medusa’s core then executes the `resendNotification` method in your Notification Provider. - -This method receives three parameters: - -1. `notification`: This is the original Notification record that was created after you sent the notification with `sendNotification`. You can get an overview of the entity and its attributes in the [architecture overview](./overview.mdx#notification-entity-overview), but most notably it includes the `to` and `data` attributes which are populated originally using the `to` and `data` properties of the object you return in `sendNotification`. -2. `config`: In the Resend Notification API Route you may specify an alternative receiver of the notification using the `to` request body parameter. For example, you may want to resend the order confirmation email to a different email. If that’s the case, you have access to it in the `config` parameter object. Otherwise, `config` will be an empty object. -3. `attachmentGenerator`: If you’ve previously attached a generator to the Notification Service using the [`registerAttachmentGenerator`](../../references/services/classes/services.NotificationService.mdx#registerattachmentgenerator) method, you have access to it here. You can use the `attachmentGenerator` to generate on-demand invoices or other documents. The default value of this parameter is null. - -Similarly to the `sendNotification` method, this method must return an object containing two properties: - -1. `to`: a string that represents the receiver of the Notification. You can either return the same `to` available in the `notification` parameter or the updated one in the `config` parameter. -2. `data`: an object that contains the data used to send the Notification. You can either return the same `data` in the `notification` parameter or make any necessary updates to it. - -Continuing with the previous example you can have the following implementation of the `resendNotification` method: - -```ts -class EmailSenderService extends AbstractNotificationService { - // ... - async resendNotification( - notification: any, - config: any, - attachmentGenerator: unknown - ): Promise<{ - to: string; - status: string; - data: Record; - }> { - // check if the receiver should be changed - const to: string = config.to ? config.to : notification.to - - // TODO resend the notification using the same data - // that is saved under notification.data - - console.log("Notification resent") - return { - to, - status: "done", - data: notification.data, // make changes to the data - } - } -} -``` - -In the above snippet, you check if the `to` should be changed by checking if the `config` parameter has a `to` property. Otherwise, you keep the same `to` address stored in the `notification` parameter. - -You then resend the email. Here, the logic related to sending the email is not implemented as it is generally specific to your Notification Provider. - -Finally, you return an object with the `to` property set to the email (either new or old) and the `data` property is the same data used before to send the original notification. you can alternatively make any changes to the data. - -:::note - -The `to` and `data` properties are used in the `NotificationService` in Medusa’s core to create a new `Notification` record in the database. No changes are made to the original `Notification` record created after the `sendNotification` method. This new record is associated with the original `Notification` record using the `parent_id` attribute in the entity. You can learn more about the `Notification` entity in the [Architecture Overview](./overview.mdx#notification-entity-overview) documentation. - -::: - ---- - -## Subscribe with Loaders - -After creating your Notification Provider Service, you must create a [Loader](../loaders/overview.mdx) that registers this Service as a notification handler of events. - -Following the previous example, to make sure the `email-sender` Notification Provider handles the `order.placed` event, create the file `src/loaders/notification.ts` with the following content: - -```ts title="src/loaders/notification.ts" -import { - MedusaContainer, - NotificationService, -} from "@medusajs/medusa" - -export default async ( - container: MedusaContainer -): Promise => { - const notificationService = container.resolve< - NotificationService - >("notificationService") - - notificationService.subscribe( - "order.placed", - "email-sender" - ) -} -``` - -This loader accesses the `notificationService` through the [MedusaContainer](../fundamentals/dependency-injection.md). The `notificationService` has a `subscribe` method that accepts 2 parameters. The first one is the name of the event to subscribe to, and the second is the identifier of the Notification Provider that's subscribing to that event. - ---- - -## Test Sending Notifications with your Notification Provider - -Make sure you have an event bus module configured in your Medusa backend. You can learn more on how to do that in the [Configurations guide](../backend/configurations.md). - -Then, run the build command in the root directory of your Medusa backend: - -```bash npm2yarn -npm run build -``` - -Next, start your Medusa backend: - -```bash npm2yarn -npx medusa develop -``` - -Try now to place an order either using the [REST APIs](https://docs.medusajs.com/api/store) or using the storefront. - -:::tip - -If you don’t have a storefront installed you can get started with the [Next.js Starter Template](../../starters/nextjs-medusa-starter.mdx) in minutes. - -::: - -After placing an order, you can see in your console the message “Notification Sent”. If you added your own notification sending logic, you should receive an email or alternatively the type of notification you’ve set up. - ---- - -## Test Resending Notifications with your Notification Provider - -To test resending a notification, first, retrieve the ID of the notification you just sent using the [List Notifications API Route](https://docs.medusajs.com/api/admin#notifications_getnotifications). You can pass as a body parameter the `to` or `event_name` parameters to filter out the notification you just sent. - -:::tip - -You must be authenticated as an admin user before sending this request. You can use the [Authenticate a User API Route](https://docs.medusajs.com/api/admin#auth_postauth) to get authenticated. - -::: - -![List Notifications Request](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001650/Medusa%20Docs/Screenshots/iF1rZX1_msps2t.png) - -Then, send a request to the [Resend Notification API Route](https://docs.medusajs.com/api/admin#notifications_postnotificationsnotificationresend) using the ID retrieved from the previous request. You can pass the `to` parameter in the body to change the receiver of the notification. You should see the message “Notification Resent” in your console and if you implemented your own logic for resending the notification it will be resent. - -![Resend Notifications Request](https://res.cloudinary.com/dza7lstvk/image/upload/v1668001659/Medusa%20Docs/Screenshots/0zFfPed_og7one.png) - -This request returns the same notification object as the List Notifications API Route, but it now has a new object in the `resends` array. This is the resent notification. If you supplied a `to` parameter in the request body, you should see its value in the `to` property of the resent notification object. - ---- - -## See Also - -- [Create a Plugin](../plugins/create.mdx) diff --git a/www/apps/docs/content/development/scheduled-jobs/create.md b/www/apps/docs/content/development/scheduled-jobs/create.md index 5968982525..2dbaa6e9d3 100644 --- a/www/apps/docs/content/development/scheduled-jobs/create.md +++ b/www/apps/docs/content/development/scheduled-jobs/create.md @@ -23,7 +23,7 @@ This guide explains how to create a scheduled job on your Medusa backend. The sc ## Prerequisites -To use scheduled jobs, you must configure Redis in your Medusa backend. Learn more in the [Configurations documentation](../backend/configurations.md#redis_url). +To use scheduled jobs, you must configure Redis in your Medusa backend. Learn more in the [Configurations documentation](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx#redis_url). --- @@ -91,7 +91,7 @@ The function accepts a parameter of type `ScheduledJobArgs`, which has the follo - `container`: The [dependency container](../fundamentals/dependency-injection.md) that allows you to resolve Medusa resources, such as services. - `data`: The data passed in the [configuration object](#scheduled-job-configuration). -- `pluginOptions`: When the scheduled job is created within a plugin, this object holds the plugin's options defined in the [Medusa configurations](../backend/configurations.md). +- `pluginOptions`: When the scheduled job is created within a plugin, this object holds the plugin's options defined in the [Medusa configurations](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx). --- diff --git a/www/apps/docs/content/development/scheduled-jobs/overview.mdx b/www/apps/docs/content/development/scheduled-jobs/overview.mdx index 01ecc33c96..7b27baf155 100644 --- a/www/apps/docs/content/development/scheduled-jobs/overview.mdx +++ b/www/apps/docs/content/development/scheduled-jobs/overview.mdx @@ -15,7 +15,7 @@ Scheduled jobs (also known as cron jobs) are tasks performed at a specific time For example, you can synchronize your inventory with an Enterprise Resource Planning (ERP) system once a day using a scheduled job. -In the Medusa Backend, the scheduled jobs queue is implemented using [Redis](https://redis.io/) and [Bull](https://www.npmjs.com/package/bull). So, for scheduled jobs to work, you must have [Redis installed and enabled](../../development/backend/configurations.md#redis). +In the Medusa Backend, the scheduled jobs queue is implemented using [Redis](https://redis.io/) and [Bull](https://www.npmjs.com/package/bull). So, for scheduled jobs to work, you must have [Redis installed and enabled](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx#redis_url). :::tip diff --git a/www/apps/docs/content/development/search/create.md b/www/apps/docs/content/development/search/create.md deleted file mode 100644 index 55c2541b7c..0000000000 --- a/www/apps/docs/content/development/search/create.md +++ /dev/null @@ -1,416 +0,0 @@ ---- -description: 'Learn how to create a search service in Medusa. You can create the search service directly in your Medusa backend codebase, in a plugin, or in a module.' -addHowToData: true ---- - -# How to Create a Search Service - -In this document, you’ll learn how to create a search service in Medusa. You can create the search service directly in your Medusa backend codebase, in a plugin, or in a module. - -## Prerequisites - -### Medusa Utils Package - -A search service must extend the `AbstractSearchService` class imported from the `@medusajs/utils` package. If you don’t already have the package installed, run the following command to install it within your project: - -```bash npm2yarn -npm install @medusajs/utils -``` - ---- - -## Step 1: Create Search Service Class - -A search service class should be defined in a TypeScript or JavaScript file created in the `src/services` directory. The class must extend the `AbstractSearchService` class imported from the `@medusajs/utils` package. - -Based on services’ naming conventions, the file’s name should be the slug version of the search service’s name without `service`, and the class’s name should be the pascal case of the search service’s name following by `Service`. - -For example, if you’re creating an algolia search service, the file name would be `algolia.ts`, whereas the class name would be `AlgoliaService`. - -:::note - -You can learn more about services and their naming convention in [this documentation](../services/overview.mdx). - -::: - -For example, create the file `src/services/my-search.ts` with the following content: - -```ts title="src/services/my-search.ts" -import { AbstractSearchService } from "@medusajs/utils" - -class MySearchService extends AbstractSearchService { - isDefault = false - - createIndex(indexName: string, options: Record) { - throw new Error("Method not implemented.") - } - getIndex(indexName: string) { - throw new Error("Method not implemented.") - } - addDocuments( - indexName: string, - documents: Record[], - type: string - ) { - throw new Error("Method not implemented.") - } - replaceDocuments( - indexName: string, - documents: Record[], - type: string - ) { - throw new Error("Method not implemented.") - } - deleteDocument( - indexName: string, - document_id: string | number - ) { - throw new Error("Method not implemented.") - } - deleteAllDocuments(indexName: string) { - throw new Error("Method not implemented.") - } - search( - indexName: string, - query: string, - options: Record - ) { - return { - message: "test", - } - } - updateSettings( - indexName: string, - settings: Record - ) { - throw new Error("Method not implemented.") - } - -} - -export default MySearchService -``` - -This creates the service `MySearchService` which, at the moment, adds a general implementation of the methods defined in the abstract class `AbstractSearchService`. - -### Using a Constructor - -You can use a constructor to access services and resources registered in the dependency container, to define any necessary clients if you’re integrating a third-party storage service, and to access plugin options if your search service is defined in a plugin. - -For example: - - - -```ts title="src/services/my-search.ts" -// ... -import { ProductService } from "@medusajs/medusa" - -type InjectedDependencies = { - productService: ProductService -} - -class MySearchService extends AbstractSearchService { - // ... - protected readonly productService_: ProductService - - constructor({ productService }: InjectedDependencies) { - // @ts-expect-error prefer-rest-params - super(...arguments) - this.productService_ = productService - } - - // ... -} -``` - -You can access the plugin options in the second parameter passed to the constructor: - - - -```ts title="src/services/my-search.ts" -// ... - -class MySearchService extends AbstractSearchService { - // ... - protected readonly pluginOptions: Record - - constructor({ - productService, - }: InjectedDependencies, pluginOptions) { - // @ts-expect-error prefer-rest-params - super(...arguments) - - // ... - this.pluginOptions = pluginOptions - } - - // ... -} -``` - -### isDefault Property - -The `isDefault` property is mainly used to pinpoint the default search service defined in the Medusa core. For custom search services, the `isDefault` property should be `false`. - ---- - -## Step 2: Implement Required Methods - -In this section, you’ll learn about the required methods to implement in the search service. - -:::note - -The Medusa backend mainly uses the `addDocuments`, `deleteDocument`, and `search` methods in different scenarios that are explained for each of the methods. Other methods can be helpful based on the search engine you’re integrating. - -::: - -### createIndex - -This method is used to create an index in the search engine. - -The method accepts two parameters: - -1. `indexName`: this is the first parameter, and it’s a string indicating the name of the index to create. -2. `options`: this is the second parameter is typically an object, and it can be used to pass any necessary options to the method. This parameter does not have any defined format. - -The method does not require any specific data type to be returned. - -An example implementation, assuming `client_` would interact with a third-party service: - -```ts title="src/services/my-search.ts" -class MySearchService extends AbstractSearchService { - // ... - - createIndex(indexName: string, options: Record) { - return this.client_.initIndex(indexName) - } -} -``` - -### getIndex - -This method is used to retrieve an index’s results from the search engine. - -The method accepts one parameter, which is a string indicating the name of the index. The method does not require any specific data type to be returned. - -An example implementation, assuming `client_` would interact with a third-party service: - -```ts title="src/services/my-search.ts" -class MySearchService extends AbstractSearchService { - // ... - - getIndex(indexName: string) { - return this.client_.getIndex(indexName) - } -} -``` - -### addDocuments - -This method is used to add a document to an index in the search engine. - -This method is used when the Medusa backend loads, indexing all products available in the Medusa backend. It’s also used whenever a new product is added or a product is updated. - -The method accepts the following parameters: - -- `indexName`: the first parameter is a string indicating the name of the index to add the document to. -- `documents`: the second parameter is typically an array of objects to index. For example, it can be an array of products to index. -- `type`: the third parameter is a string indicating the type of object being indexed. For example, when indexing products, the type would be `products`. - -The method should return the response of saving the documents in the search engine, but there’s no required format of the response. - -An example implementation, assuming `client_` would interact with a third-party service: - -```ts title="src/services/my-search.ts" -class MySearchService extends AbstractSearchService { - // ... - - async addDocuments( - indexName: string, - documents: Record[], - type: string - ) { - return await this.client_ - .addDocuments(indexName, documents) - } -} -``` - -### replaceDocuments - -This method is used to replace the existing documents in the search engine of an index with new documents. - -The method accepts the following parameters: - -- `indexName`: the first parameter is a string indicating the name of the index to replace the documents in. -- `documents`: the second parameter is typically an array of objects to index. For example, it can be an array of products to index. This would be the new documents to add to the index. -- `type`: the third parameter is a string indicating the type of object being indexed. For example, when indexing products, the type would be `products`. - -The method should return the response of saving the documents in the search engine, but there’s no required format of the response. - -An example implementation, assuming `client_` would interact with a third-party service: - -```ts title="src/services/my-search.ts" -class MySearchService extends AbstractSearchService { - // ... - - async replaceDocuments( - indexName: string, - documents: Record[], - type: string - ) { - await this.client_ - .removeDocuments(indexName) - return await this.client_ - .addDocuments(indexName, documents) - } -} -``` - -### deleteDocument - -This method is used to delete a document from an index. - -When a product is deleted in the Medusa backend, this method is used to delete the product from the search engine’s index. - -The method accepts the following parameters: - -- `indexName`: the first parameter is a string indicating the name of the index this document belongs in. -- `document_id`: the second parameter is a string or a number indicating the ID of the document to delete. When a product is deleted, the product’s ID is passed as the value of this parameter. - -The method should return the response of deleting the document in the search engine, but there’s no required format of the response. - -An example implementation, assuming `client_` would interact with a third-party service: - -```ts title="src/services/my-search.ts" -class MySearchService extends AbstractSearchService { - // ... - - async deleteDocument( - indexName: string, - document_id: string | number - ) { - return await this.client_ - .deleteDocument(indexName, document_id) - } -} -``` - -### deleteAllDocuments - -This method is used to delete all documents from an index. - -The method accepts one parameter, which is a string indicating the name of the index to delete its documents. - -The method should return the response of deleting the documents of that index in the search engine, but there’s no required format of the response. - -An example implementation, assuming `client_` would interact with a third-party service: - -```ts title="src/services/my-search.ts" -class MySearchService extends AbstractSearchService { - // ... - - async deleteAllDocuments(indexName: string) { - return await this.client_ - .deleteDocuments(indexName) - } -} -``` - -### search - -This method is used to search through an index by a query. - -In the Medusa backend, this method is used within the [Search Products API Route](https://docs.medusajs.com/api/store#products_postproductssearch) to retrieve the search results. - -This method accepts the following parameters: - -1. `indexName`: the first parameter is a string indicating the index to search through. When using the Search Products API Route, the index is the default index defined in the `IndexName` static property of the `ProductService`, which is `products`. -2. `query`: the second parameter is a string indicating the query to use to search through the documents. -3. `options`: the third parameter is typically an object that can be used to pass any necessary options to the search engine. - -Although there’s no required data format or type to be returned to the method, it’s recommended to return an object having a property `hits` with its value being an array of results. Each result can be an object of any format. This is recommended as this is the convention followed within Medusa’s official search plugins. - -An example implementation, assuming `client_` would interact with a third-party service: - -```ts title="src/services/my-search.ts" -class MySearchService extends AbstractSearchService { - // ... - - async search( - indexName: string, - query: string, - options: Record - ) { - const hits = await this.client_ - .search(indexName, query) - return { - hits, - } - } -} -``` - -### updateSettings - -This method is used to update the settings of an index within the search engine. This can be useful if you want to update the index settings when the plugin options change. - -For example, in the Algolia plugin, a loader, which runs when the Medusa backend loads, is used to update the settings of indices based on the plugin options. The loader uses this method to update the settings. - -The method accepts the following parameters: - -1. `indexName`: the first parameter is a string indicating the index that should be updated. -2. `settings`: the second parameter is typically an object that holds the settings of the index. There’s no defined format for this parameter. - -The method should return the response of updating the index in the search engine, but there’s no required format of the response. - -An example implementation, assuming `client_` would interact with a third-party service: - -```ts title="src/services/my-search.ts" -class MySearchService extends AbstractSearchService { - // ... - - async updateSettings( - indexName: string, - settings: Record - ) { - return await this.client_ - .updateSettings(indexName, settings) - } -} -``` - ---- - -## Step 3: Run Build Command - -In the directory of the Medusa backend, run the build command to transpile the files in the `src` directory into the `dist` directory: - -```bash npm2yarn -npm run build -``` - ---- - -## Test it Out - -:::note - -This section explains how to test out your implementation if the search service was created in the Medusa backend codebase. You can refer to [the plugin documentation](../plugins/create.mdx#test-your-plugin) on how to test a plugin. - -::: - -Run your backend to test it out: - -```bash npm2yarn -npx medusa develop -``` - -You can then send a request to the [Search Products API Route](https://docs.medusajs.com/api/store#products_postproductssearch) to see if your search service returns any results. - ---- - -## See Also - -- [How to create a plugin](../plugins/create.mdx) -- [How to publish a plugin](../plugins/publish.mdx) diff --git a/www/apps/docs/content/development/strategies/override-strategy.md b/www/apps/docs/content/development/strategies/override-strategy.md index 40da7cd681..009c928115 100644 --- a/www/apps/docs/content/development/strategies/override-strategy.md +++ b/www/apps/docs/content/development/strategies/override-strategy.md @@ -36,8 +36,8 @@ This guide explains how to override a strategy in general. It doesn’t explain There are other resources that provide steps specific to a strategy type: - [How to override the Cart Completion Strategy](../../modules/carts-and-checkout/backend/cart-completion-strategy.md) -- [How to override the Tax Calculation Strategy](../../modules/taxes/backend/tax-calculation-strategy.md) -- [How to override the Price Selection Strategy](../../modules/price-lists/backend/override-price-selection-strategy.mdx) +- [How to override the Tax Calculation Strategy](../../references/tax_calculation/classes/tax_calculation.AbstractTaxCalculationStrategy.mdx) +- [How to override the Price Selection Strategy](/modules/price-lists/price-selection-strategy) - [How to override a Batch Job Strategy](../batch-jobs/customize-import.md) --- diff --git a/www/apps/docs/content/experimental/pricing/install-nodejs.md b/www/apps/docs/content/experimental/pricing/install-nodejs.md index 9de7384b15..f6873ebbb6 100644 --- a/www/apps/docs/content/experimental/pricing/install-nodejs.md +++ b/www/apps/docs/content/experimental/pricing/install-nodejs.md @@ -29,7 +29,7 @@ Add the following environment variable to your application: POSTGRES_URL= ``` -Where `` is your database connection URL of the format `postgres://[user][:password]@[host][:port]/[dbname]`. You can learn more about the connection URL format in [this guide](../../development/backend/configurations.md#database_url). +Where `` is your database connection URL of the format `postgres://[user][:password]@[host][:port]/[dbname]`. You can learn more about the connection URL format in [this guide](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx#database_url). You can also set the following optional environment variables: diff --git a/www/apps/docs/content/experimental/product/install-nodejs.md b/www/apps/docs/content/experimental/product/install-nodejs.md index 3c9ce6116d..b6e0055419 100644 --- a/www/apps/docs/content/experimental/product/install-nodejs.md +++ b/www/apps/docs/content/experimental/product/install-nodejs.md @@ -29,7 +29,7 @@ Add the following environment variable to your application: POSTGRES_URL= ``` -Where `` is your database connection URL of the format `postgres://[user][:password]@[host][:port]/[dbname]`. You can learn more about the connection URL format in [this guide](https://www.notion.so/development/backend/configurations.md#database_url). +Where `` is your database connection URL of the format `postgres://[user][:password]@[host][:port]/[dbname]`. You can learn more about the connection URL format in [this guide](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx#database_url). You can also set the following optional environment variables: diff --git a/www/apps/docs/content/modules/customers/backend/send-confirmation.md b/www/apps/docs/content/modules/customers/backend/send-confirmation.md index e6c9c2d0fd..2cbdabf67b 100644 --- a/www/apps/docs/content/modules/customers/backend/send-confirmation.md +++ b/www/apps/docs/content/modules/customers/backend/send-confirmation.md @@ -29,7 +29,7 @@ The [Local Event Bus module](../../../development/events/modules/local.md) works As mentioned in the overview, this guide illustrates how to send the email using SendGrid. If you intend to follow along, you must have the [SendGrid plugin](../../../plugins/notifications/sendgrid.mdx) installed and configured. -You can also find other available Notification provider plugins in the [Plugins directory](https://medusajs.com/plugins/), or [create your own](../../../development/notification/create-notification-provider.md). +You can also find other available Notification provider plugins in the [Plugins directory](https://medusajs.com/plugins/), or [create your own](../../../references/notification/classes/notification.AbstractNotificationService.mdx). --- @@ -141,6 +141,6 @@ Where `` is the identifier for your notifica :::note -You can learn more about handling events with the Notification Service using [this documentation](../../../development/notification/create-notification-provider.md). +You can learn more about handling events with the Notification Service using [this documentation](../../../references/notification/classes/notification.AbstractNotificationService.mdx). ::: diff --git a/www/apps/docs/content/modules/gift-cards/backend/send-gift-card-to-customer.md b/www/apps/docs/content/modules/gift-cards/backend/send-gift-card-to-customer.md index 80977f6fdd..fb0b81d65a 100644 --- a/www/apps/docs/content/modules/gift-cards/backend/send-gift-card-to-customer.md +++ b/www/apps/docs/content/modules/gift-cards/backend/send-gift-card-to-customer.md @@ -31,7 +31,7 @@ It's assumed that you already have a Medusa backend installed and set up. If not ### Notification Provider -To send an email or another type of notification method, you must have a notification provider installed or configured. You can either install an [existing plugin](../../../plugins/notifications/index.mdx) or [create your own](../../../development/notification/create-notification-provider.md). +To send an email or another type of notification method, you must have a notification provider installed or configured. You can either install an [existing plugin](../../../plugins/notifications/index.mdx) or [create your own](../../../references/notification/classes/notification.AbstractNotificationService.mdx). --- @@ -149,6 +149,6 @@ Where `` is the identifier for your notifica :::note -You can learn more about handling events with the Notification Service using [this documentation](../../../development/notification/create-notification-provider.md). +You can learn more about handling events with the Notification Service using [this documentation](../../../references/notification/classes/notification.AbstractNotificationService.mdx). ::: diff --git a/www/apps/docs/content/modules/orders/backend/handle-order-claim-event.md b/www/apps/docs/content/modules/orders/backend/handle-order-claim-event.md index 2ee7e7fceb..4a354cde72 100644 --- a/www/apps/docs/content/modules/orders/backend/handle-order-claim-event.md +++ b/www/apps/docs/content/modules/orders/backend/handle-order-claim-event.md @@ -27,7 +27,7 @@ It's assumed that you already have a Medusa backend installed and set up. If not ### Notification Provider -To send an email or another type of notification method, you must have a notification provider installed or configured. You can either install an existing plugin or [create your own](../../../development/notification/create-notification-provider.md). +To send an email or another type of notification method, you must have a notification provider installed or configured. You can either install an existing plugin or [create your own](../../../references/notification/classes/notification.AbstractNotificationService.mdx). This document has an example using the [SendGrid](../../../plugins/notifications/sendgrid.mdx) plugin. @@ -153,7 +153,7 @@ Where `` is the identifier for your notifica :::note -You can learn more about handling events with the Notification Service using [this documentation](../../../development/notification/create-notification-provider.md). +You can learn more about handling events with the Notification Service using [this documentation](../../../references/notification/classes/notification.AbstractNotificationService.mdx). ::: diff --git a/www/apps/docs/content/modules/orders/backend/send-order-confirmation.md b/www/apps/docs/content/modules/orders/backend/send-order-confirmation.md index 2b4135b00f..657ae367cf 100644 --- a/www/apps/docs/content/modules/orders/backend/send-order-confirmation.md +++ b/www/apps/docs/content/modules/orders/backend/send-order-confirmation.md @@ -27,7 +27,7 @@ The [Local Event Bus module](../../../development/events/modules/local.md) works As mentioned in the overview, this guide illustrates how to send the email using SendGrid. If you intend to follow along, you must have the [SendGrid plugin](../../../plugins/notifications/sendgrid.mdx) installed and configured. -You can also find other available Notification provider plugins in the [Plugins directory](https://medusajs.com/plugins/), or [create your own](../../../development/notification/create-notification-provider.md). +You can also find other available Notification provider plugins in the [Plugins directory](https://medusajs.com/plugins/), or [create your own](../../../references/notification/classes/notification.AbstractNotificationService.mdx). --- @@ -153,6 +153,6 @@ Where `` is the identifier for your notifica :::note -You can learn more about handling events with the Notification Service using [this documentation](../../../development/notification/create-notification-provider.md). +You can learn more about handling events with the Notification Service using [this documentation](../../../references/notification/classes/notification.AbstractNotificationService.mdx). ::: diff --git a/www/apps/docs/content/modules/price-lists/backend/override-price-selection-strategy.mdx b/www/apps/docs/content/modules/price-lists/backend/override-price-selection-strategy.mdx deleted file mode 100644 index dfb7d6bf2b..0000000000 --- a/www/apps/docs/content/modules/price-lists/backend/override-price-selection-strategy.mdx +++ /dev/null @@ -1,295 +0,0 @@ ---- -description: 'Learn how to override the price selection strategy. The price selection strategy is used to determine the best price based on a specific context.' -addHowToData: true ---- - -import ParameterTypes from "@site/src/components/ParameterTypes" - -# How to Override Price Selection Strategy - -In this document, you’ll learn how to override Medusa’s price selection strategy to create a custom pricing strategy. - -:::note - -If you’re interested in learning what a price selection strategy is and how it works, check out [this documentation](../price-selection-strategy.md) instead. - -::: - -## 1. Create Class - -Create a TypeScript or JavaScript file in `src/strategies` of your Medusa backend project with a class that extends the `AbstractPriceSelectionStrategy` class: - -```ts title="src/strategies/price.ts" -import { - AbstractPriceSelectionStrategy, - PriceSelectionContext, - PriceSelectionResult, -} from "@medusajs/medusa" -import { - TaxServiceRate, -} from "@medusajs/medusa/dist/types/tax-service" - -export default class MyStrategy extends - AbstractPriceSelectionStrategy { - - async calculateVariantPrice( - data: { - variantId: string; - taxRates: TaxServiceRate[]; - quantity?: number - }[], - context: PriceSelectionContext - ): Promise> { - throw new Error("Method not implemented.") - } -} -``` - -### Resolve Resources - -You can resolve resources like services or repositories using [dependency injection](../../../development/fundamentals/dependency-injection.md). - -For example: - -```ts title="src/strategies/price.ts" -import { - AbstractPriceSelectionStrategy, - CustomerService, - PriceSelectionContext, - PriceSelectionResult, -} from "@medusajs/medusa" -import { - TaxServiceRate, -} from "@medusajs/medusa/dist/types/tax-service" - -type InjectedDependencies = { - customerService: CustomerService -} - -export default class MyStrategy extends - AbstractPriceSelectionStrategy { - - protected customerService_: CustomerService - - constructor(container: InjectedDependencies) { - super(container) - this.customerService_ = container.customerService - } - - // ... -} -``` - ---- - -## 2. Implement calculateVariantPrice - -In this method, you can implement your price selection strategy. - -### Parameters - -You can learn more about optional properties and the meaning behind every property [here](../price-selection-strategy.md#calculatevariantprice-method). - - - -### Returns - ->", - description: "A map, each key is an ID of a variant, and its value is an object holding the price selection result.", - optional: false, - children: [ - { - name: "PriceSelectionResult", - type: "PriceSelectionResult", - description: "The price selection result of a variant.", - optional: false, - children: [ - { - name: "originalPrice", - type: "number | null", - description: "The original price of the variant which depends on the selected region or currency code in the context object. If both region ID and currency code are available in the context object, the region has higher precedence.", - optional: false - }, - { - name: "originalPriceIncludesTax", - type: "boolean | null", - description: "Whether the original price includes taxes or not. This is only available for [Tax-Inclusive Pricing](../../taxes/inclusive-pricing.md).", - optional: true - }, - { - name: "calculatedPrice", - type: "number | null", - description: "The lowest price among the prices of the product variant retrieved using the context object.", - optional: false - }, - { - name: "calculatedPriceIncludesTax", - type: "boolean | null", - description: "Whether the calculated price includes taxes or not. This is only available for [Tax-Inclusive Pricing](../../taxes/inclusive-pricing.md).", - optional: true - }, - { - name: "calculatedPriceType", - type: "enum", - description: "Either `default` if the `calculatedPrice` is the original price, or the type of the price list applied, which can be `override` or `sale`.", - optional: true - }, - { - name: "prices", - type: "[MoneyAmount](../../../references/entities/classes/entities.MoneyAmount.mdx)[]", - description: "The prices of the variant retrieved using the `context` object. It can include its original price and its price lists if there are any.", - optional: false - } - ], - } - ], - }, -]} /> - ---- - -## 3. Run Build Command - -In your terminal, run the build command to transpile the files in the `src` directory into the `dist` directory: - -```bash npm2yarn -npm run build -``` - ---- - -## Test it Out - -Run your backend to test it out: - -```bash npm2yarn -npx medusa develop -``` - -Then, try out your strategy using any of the [Products](https://docs.medusajs.com/api/store#products) or [Carts](https://docs.medusajs.com/api/store#carts) API Routes which include retrieving product variants and line items respectively. You should then see the prices in the response based on your implemented strategy. diff --git a/www/apps/docs/content/modules/price-lists/overview.mdx b/www/apps/docs/content/modules/price-lists/overview.mdx index 960de0f3cb..9aef3e0c52 100644 --- a/www/apps/docs/content/modules/price-lists/overview.mdx +++ b/www/apps/docs/content/modules/price-lists/overview.mdx @@ -45,7 +45,7 @@ Developers can change the default logic behind how prices are selected to be sho }, { type: 'link', - href: '/modules/price-lists/backend/override-price-selection-strategy', + href: '/modules/price-lists/price-selection-strategy', label: 'Backend: Override Price Selection', customProps: { icon: Icons['users-solid'], diff --git a/www/apps/docs/content/modules/price-lists/price-lists.md b/www/apps/docs/content/modules/price-lists/price-lists.md index 5972fb0cff..dc77ea2930 100644 --- a/www/apps/docs/content/modules/price-lists/price-lists.md +++ b/www/apps/docs/content/modules/price-lists/price-lists.md @@ -45,11 +45,11 @@ You can use any of the following conditions: ## How are Price Lists Applied -When a product or a line item is retrieved or manipulated on the storefront, Medusa determines its price using a Price Selection Strategy. The price selection strategy determines the best price to apply in a given [context](./price-selection-strategy.md#context-object). Part of determining the price depends on the price list. +When a product or a line item is retrieved or manipulated on the storefront, Medusa determines its price using a Price Selection Strategy. The price selection strategy determines the best price to apply in a given context. Part of determining the price depends on the price list. :::info -This section explains how the price selection strategy uses price lists when it determines the price of a product variant. If you want full details on how the price selection strategy works, check out this documentation instead. +This section explains how the [price selection strategy](../../references/price_selection/interfaces/price_selection.IPriceSelectionStrategy.mdx) uses price lists when it determines the price of a product variant. If you want full details on how the price selection strategy works, check out [this documentation](../../references/price_selection/interfaces/price_selection.IPriceSelectionStrategy.mdx) instead. ::: @@ -59,7 +59,7 @@ When the strategy calculates the prices of a product variant, it retrieves both The original price depends on the selected region or currency code in the current context, where the region has higher precedence. -The calculated price is the lowest price among all retrieved prices. Retrieved prices can include the original price and the price lists that can be applied. Prices are retrieved based on the [context](./price-selection-strategy.md#context-object). +The calculated price is the lowest price among all retrieved prices. Retrieved prices can include the original price and the price lists that can be applied. Prices are retrieved based on the provided context, such as region ID or currency code. In the [Get Product](https://docs.medusajs.com/api/store#products_getproductsproduct) and [List Product](https://docs.medusajs.com/api/store#products_getproducts) API Routes, you must pass either the `region_id` or `currency_code` to retrieve the correct prices, as they are part of the price selection strategy context. @@ -87,5 +87,5 @@ Since the line item belongs to a cart, there’s no need to pass the `region_id` ## See Also -- [Price Selection Strategy Overview](./price-selection-strategy.md) +- [Price Selection Strategy](../../references/price_selection/classes/price_selection.AbstractPriceSelectionStrategy.mdx) - [Manage price lists using the admin APIs](./admin/manage-price-lists.mdx) diff --git a/www/apps/docs/content/modules/price-lists/price-selection-strategy.md b/www/apps/docs/content/modules/price-lists/price-selection-strategy.md deleted file mode 100644 index f5b110b816..0000000000 --- a/www/apps/docs/content/modules/price-lists/price-selection-strategy.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -description: 'Learn what the price selection strategy is in the Medusa backend. The price selection strategy retrieves the best price for a product variant for a specific context.' ---- - -# Price Selection Strategy - -In this document, you’ll learn what a price selection strategy is. - -:::note - -If you’re interested to learn how to override the price selection strategy, check out [this documentation](./backend/override-price-selection-strategy.mdx) instead. - -::: - -## What's a Price Selection Strategy - -Medusa provides many features and different ways to control the price of a product variant. This includes price lists and their different conditions, products’ original prices, and taxes. - -Medusa uses the `PriceSelectionStrategy` class to retrieve the best price for a product variant for a specific context. This strategy is used whenever products and line items are retrieved or manipulated on the storefront. - ---- - -## PriceSelectionStrategy Overview - -The `PriceSelectionStrategy` class extends the `AbstractPriceSelectionStrategy` class. Its main method is the `calculateVariantPrice`. - -### calculateVariantPrice Method - -Medusa uses this method to retrieve one or more product variants' prices. This method is used when retrieving product variants or their associated line items. It's also used when retrieving other entities that product variants and line items belong to, such as products and carts respectively. - -This method accepts two parameters: - -1. The first parameter is an array of objects, each object having the following properties: - 1. `variantId`: a string indicating the ID of the variant to calculate the price for. - 2. `quantity`: an optional number indicating the quantity of the variant. -2. A [context](#context-object) object. - -The method retrieves all the available prices of the variant based on the conditions in the context object. - -It returns an object with the following properties: - -1. `originalPrice`: The original price of the variant which depends on the selected region or currency code in the context object. If both region ID and currency code are available in the context object, the region has higher precedence. -2. `originalPriceIncludesTax`: A boolean value indicating whether the original price includes taxes or not. This is only available for [Tax-Inclusive Pricing](../taxes/inclusive-pricing.md). -3. `calculatedPrice`: The lowest price among the prices of the product variant retrieved using the context object. -4. `calculatedPriceIncludesTax`: A boolean value indicating whether the calculated price includes taxes or not. This is only available for [Tax-Inclusive Pricing](../taxes/inclusive-pricing.md). -5. `calculatedPriceType`: Either `default` if the `calculatedPrice` is the original price, or the type of the price list applied. -6. `prices`: an array of all the prices of the variant retrieved using the context object. It can include its original price and its price lists if there are any. - -:::info - -You can learn more about price lists and how they’re used in [this documentation](./price-lists.md). - -::: - -### Context Object - -The context that is passed to the `calculateVariantPrice` method is an object that has the following optional properties: - -- `cart_id`: A string indicating the ID of the customer’s cart. This is used when the prices are being retrieved for the variant of a line item, as it is used to determine the current region and currency code of the context. -- `customer_id`: A string indicating the ID of the customer. This is used to filter out price lists for a customer group that this customer doesn’t belong to. -- `quantity`: A number indicating the quantity of the item in the cart. This is used to filter out price lists that have `min_quantity` or `max_quantity` conditions set. -- `region_id`: A string indicating the ID of the region the customer is using. -- `currency_code`: A string indicating the currency code the customer is using. -- `include_discount_prices`: A boolean value indicating whether price list prices should be retrieved or not. -- `tax_rates`: An array of objects indicating the tax rates to be applied. This is only used for [Tax-Inclusive Pricing](../taxes/inclusive-pricing.md). -- `ignore_cache`: a boolean value indicating whether to calculate the prices even if the value of an earlier price calculation is available in the cache. - ---- - -## See Also - -- [Override the Price Selection Strategy](./backend/override-price-selection-strategy.mdx) \ No newline at end of file diff --git a/www/apps/docs/content/modules/regions-and-currencies/currencies.md b/www/apps/docs/content/modules/regions-and-currencies/currencies.md index e65e1be553..de71632167 100644 --- a/www/apps/docs/content/modules/regions-and-currencies/currencies.md +++ b/www/apps/docs/content/modules/regions-and-currencies/currencies.md @@ -86,5 +86,5 @@ The relation is available on the `PaymentCollection` entity by expanding the `cu ## See Also -- [Price Selection Strategy](../price-lists/price-selection-strategy.md) +- [Price Selection Strategy](../../references/price_selection/classes/price_selection.AbstractPriceSelectionStrategy.mdx) - [Tax-Inclusive Pricing](../taxes/inclusive-pricing.md) diff --git a/www/apps/docs/content/modules/taxes/backend/create-tax-provider.md b/www/apps/docs/content/modules/taxes/backend/create-tax-provider.md deleted file mode 100644 index 02a629d866..0000000000 --- a/www/apps/docs/content/modules/taxes/backend/create-tax-provider.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -description: 'Learn how to create a tax provider. You can create a tax provider in a Medusa backend or a plugin.' -addHowToData: true ---- - -# How to Create a Tax Provider - -In this document, you’ll learn how to create a tax provider. - -## Overview - -A tax provider is used to retrieve the tax lines in a cart. The Medusa backend provides a default `system` provider. You can create your own tax provider, either in a plugin or directly in your Medusa backend, then use it in any region. - ---- - -## Step 1: Create Tax Provider Class - -A tax provider class should be defined in a TypeScript or JavaScript file under `src/services` and the class should extend `AbstractTaxService` imported from `@medusajs/medusa`. - -For example, you can create the file `src/services/my-tax.ts` with the following content: - -```ts title="src/services/my-tax.ts" -import { - AbstractTaxService, - ItemTaxCalculationLine, - ShippingTaxCalculationLine, - TaxCalculationContext, -} from "@medusajs/medusa" -import { - ProviderTaxLine, -} from "@medusajs/medusa/dist/types/tax-service" - -class MyTaxService extends AbstractTaxService { - async getTaxLines( - itemLines: ItemTaxCalculationLine[], - shippingLines: ShippingTaxCalculationLine[], - context: TaxCalculationContext): - Promise { - throw new Error("Method not implemented.") - } -} - -export default MyTaxService -``` - -Since the class extends `AbstractTaxService`, it must implement its abstract method `getTaxLines`, which is explained later in this guide. - -### Using a Constructor - -You can use a constructor to access services and resources registered in the dependency container using dependency injection. For example: - -```ts title="src/services/my-tax.ts" -// ... -import { LineItemService } from "@medusajs/medusa" - -type InjectedDependencies = { - lineItemService: LineItemService -} - -class MyTaxService extends AbstractTaxService { - protected readonly lineItemService_: LineItemService - - constructor({ lineItemService }: InjectedDependencies) { - super() - this.lineItemService_ = lineItemService - } - - // ... -} - -export default MyTaxService -``` - ---- - -## Step 2: Define Identifier - -Every tax provider must have a unique identifier. The identifier is defined as a static property in the class, and its value is used when registering the tax provider in the database and in the dependency container. - -Add the static property `identifier` in your tax provider class: - -```ts title="src/services/my-tax.ts" -class MyTaxService extends AbstractTaxService { - static identifier = "my-tax" - // ... -} -``` - -Make sure to change `my-tax` to the name of your tax provider. - ---- - -## Step 3: Implement getTaxLines Method - -The `getTaxLines` method is the only required method in a tax provider. It’s used when retrieving the tax lines for line items and shipping methods, typically during checkout or when calculating totals, for example, for orders, swaps, or returns. - -The method accepts three parameters. The first parameter is an array of tax calculation objects for line items. Each object having the following properties: - -- `item`: a line item object. -- `rates`: an array of objects, each object having the following properties: - - `rate`: an optional number indicating the tax rate. - - `name`: a string indicating the name of the tax rate. - - `code`: an optional string indicating the tax code. - -The second parameter is an array of tax calculation objects for shipping methods. Each object having the following properties: - -- `shipping_method`: a shipping method object. -- `rates`: an array of objects, each object having the following properties: - - `rate`: an optional number indicating the tax rate. - - `name`: a string indicating the name of the tax rate. - - `code`: an optional string indicating the tax code. - -The third parameter is a context object that can be helpful for the tax calculation. The object can have the following properties: - -- `shipping_address`: an optional address object used for shipping. -- `customer`: an optional customer object. -- `region`: an optional region object. -- `is_return`: a boolean value that determines whether the taxes are being calculated for a return flow. -- `shipping_methods`: an array of shipping methods being used in the current context. -- `allocation_map`: an object that indicates the gift cards and discounts applied on line items. Each object key or property is an ID of a line item, and the value is an object having the following properties: - - `gift_card`: an optional object indicating the gift card applied on the line item. - - `discount`: an optional object indicating the discount applied on the line item. - -This method is expected to return an array of line item tax line or shipping method tax line objects. - -The line item tax line object has the following properties: - -- `rate`: a number indicating the tax rate. -- `name`: a string indicating the name of the tax rate. -- `code`: a string indicating the tax code. -- `item_id`: the ID of the line item. -- `metadata`: an optional object that can hold any necessary additional data to be added to the line item tax lines. - -:::note - -Tax lines for line item must have a unique `code` and `item_id` combination. Otherwise, the tax lines will be applied multiple times. - -::: - -The shipping method tax line object has the following properties: - -- `rate`: a number indicating the tax rate. -- `name`: a string indicating the name of the tax rate. -- `code`: a string indicating the tax code. -- `shipping_method_id`: the ID of the shipping method. -- `metadata`: an optional object that can hold any necessary additional data to be added to the shipping method tax lines. - -:::note - -Tax lines for a shipping method must have a unique `code` and `shipping_method_id` combination. Otherwise, the tax lines will be applied multiple times. - -::: - -The returned array would be a combination of both the line item tax lines and shipping method tax lines. - -:::note - -The Medusa backend determines whether an object in the returned array is a shipping method tax line item, depending on the availability of the `shipping_method_id` attribute. For line items, it depends on the availability of the `item_id` attribute. - -::: - -For example, the `system` tax provider returns the tax calculation line items in the first parameter and the tax calculation shipping methods in the second parameter as is: - -```ts title="src/services/my-tax.ts" -// ... - -class SystemTaxService extends AbstractTaxService { - // ... - - async getTaxLines( - itemLines: ItemTaxCalculationLine[], - shippingLines: ShippingTaxCalculationLine[], - context: TaxCalculationContext - ): Promise { - let taxLines: ProviderTaxLine[] = itemLines.flatMap((l) => { - return l.rates.map((r) => ({ - rate: r.rate || 0, - name: r.name, - code: r.code, - item_id: l.item.id, - })) - }) - - taxLines = taxLines.concat( - shippingLines.flatMap((l) => { - return l.rates.map((r) => ({ - rate: r.rate || 0, - name: r.name, - code: r.code, - shipping_method_id: l.shipping_method.id, - })) - }) - ) - - return taxLines - } -} -``` - ---- - -## Step 3: Run the Build Command - -In the directory of the Medusa backend, run the `build` command to transpile the files in the `src` directory into the `dist` directory: - -```bash npm2yarn -npm run build -``` - ---- - -## Test it Out - -Run your backend to test it out: - -```bash npm2yarn -npx medusa develop -``` - -Before you can test out your tax provider, you must enable it in a region. You can do that either using the [Medusa Admin dashboard](../../../user-guide/taxes/manage.md#change-tax-provider) or using the [Update Region admin API Route](../admin/manage-tax-settings.mdx#change-tax-provider-of-a-region). - -Then, you can test out the tax provider by simulating a checkout process in that region. You should see the line item tax lines in the cart’s `items`, as each item object has a `tax_lines` array which are the tax lines that you return in the `getTaxLines` method for line items. - -Similarly, you should see the shipping method tax lines in the cart’s `shipping_methods`, as each shipping method object has a `tax_lines` array which are the tax lines that you return in the `getTaxLines` method for shipping methods. diff --git a/www/apps/docs/content/modules/taxes/backend/tax-calculation-strategy.md b/www/apps/docs/content/modules/taxes/backend/tax-calculation-strategy.md deleted file mode 100644 index 39927fdbb9..0000000000 --- a/www/apps/docs/content/modules/taxes/backend/tax-calculation-strategy.md +++ /dev/null @@ -1,132 +0,0 @@ ---- -description: 'Learn how to create a tax provider. You can create a tax provider in a Medusa backend or a plugin.' -addHowToData: true ---- - -# How to Override a Tax Calculation Strategy - -In this document, you’ll learn how to override a tax calculation strategy. - -## Overview - -A tax calculation strategy is used to calculate taxes when calculating totals. The Medusa backend provides a tax calculation strategy that handles calculating the taxes accounting for defined tax rates, and settings such as whether tax-inclusive pricing is enabled. - -You can override the tax calculation strategy to implement different calculation logic or to integrate a third-party service that handles the tax calculation. You can override it either in a Medusa backend setup or in a plugin. - ---- - -## Step 1: Create Strategy Class - -A tax calculation strategy should be defined in a TypeScript or JavaScript file created under the `src/strategies` directory. The class must also implement the `ITaxCalculationStrategy` interface imported from the `@medusajs/medusa` package. - -For example, you can create the file `src/strategies/tax-calculation.ts` with the following content: - -```ts title="src/strategies/tax-calculation.ts" -import { - ITaxCalculationStrategy, - LineItem, - LineItemTaxLine, - ShippingMethodTaxLine, - TaxCalculationContext, -} from "@medusajs/medusa" - -class TaxCalculationStrategy - implements ITaxCalculationStrategy { - - async calculate( - items: LineItem[], - taxLines: (ShippingMethodTaxLine | LineItemTaxLine)[], - calculationContext: TaxCalculationContext - ): Promise { - throw new Error("Method not implemented.") - } - -} - -export default TaxCalculationStrategy -``` - -Note that you add a basic implementation of the `calculate` method because it’s required by the `ITaxCalculationStrategy` interface. You’ll learn about the method later in the guide. - -### Using a Constructor - -You can use a constructor to access services and resources registered in the dependency container using dependency injection. For example: - -```ts title="src/strategies/tax-calculation.ts" -// ... -import { - LineItemService, -} from "@medusajs/medusa" - -type InjectedDependencies = { - lineItemService: LineItemService -} - -class TaxCalculationStrategy - implements ITaxCalculationStrategy { - - protected readonly lineItemService_: LineItemService - - constructor({ lineItemService }: InjectedDependencies) { - this.lineItemService_ = lineItemService - } - - // ... -} -``` - ---- - -## Step 2: Implement the calculate Method - -A tax calculation strategy is only required to implement the `calculate` method. This method is used whenever the totals are calculated. - -:::tip - -If automatic tax calculation is disabled, then the tax calculation strategy will only be used when taxes are calculated manually as explain [this guide](../storefront/manual-calculation.md). - -::: - -The `calculate` method expects three parameters: - -- `items`: the first parameter is an array of [line item](../../../references/entities/classes/entities.LineItem.mdx) objects. -- `taxLines`: the second parameter is an array of either [shipping method tax line](../../../references/entities/classes/entities.ShippingMethodTaxLine.mdx) or [line item tax line](../../../references/entities/classes/entities.LineItemTaxLine.mdx) objects. -- `calculationContext`: an object holding the context of the tax calculation. The object has the following properties: - - `shipping_address`: an optional address object used for shipping. - - `customer`: an optional customer object. - - `region`: an optional region object. - - `is_return`: a boolean value that determines whether the taxes are being calculated for a return flow. - - `shipping_methods`: an array of shipping methods being used in the current context. - - `allocation_map`: an object that indicates the gift cards and discounts applied on line items. Each object key or property is an ID of a line item, and the value is an object having the following properties: - - `gift_card`: an optional object indicating the gift card applied on the line item. - - `discount`: an optional object indicating the discount applied on the line item. - -The method returns a number, being the tax amount for the line items, tax lines, and context provided. - ---- - -## Step 3: Run Build Command - -In the directory of the Medusa backend, run the `build` command to transpile the files in the `src` directory into the `dist` directory: - -```bash npm2yarn -npm run build -``` - ---- - -## Test it Out - -Run your backend to test it out: - -```bash npm2yarn -npx medusa develop -``` - -To test it out, you can simulate a checkout flow and check the calculated taxes to see if it matches the logic you implemented in the `calculate` method. - -:::tip - -As mentioned earlier, if automatic calculation of taxes is disabled in the region, you have to manually trigger tax calculation as explained in [this guide](../storefront/manual-calculation.md). - -::: diff --git a/www/apps/docs/content/modules/users/backend/send-invite.md b/www/apps/docs/content/modules/users/backend/send-invite.md index 565f1decd9..717394f4bc 100644 --- a/www/apps/docs/content/modules/users/backend/send-invite.md +++ b/www/apps/docs/content/modules/users/backend/send-invite.md @@ -27,7 +27,7 @@ The [Local Event Bus module](../../../development/events/modules/local.md) works As mentioned in the overview, this guide illustrates how to send the email using SendGrid. If you intend to follow along, you must have the [SendGrid plugin](../../../plugins/notifications/sendgrid.mdx) installed and configured. -You can also find other available Notification provider plugins in the [Plugins directory](https://medusajs.com/plugins/), or [create your own](../../../development/notification/create-notification-provider.md). +You can also find other available Notification provider plugins in the [Plugins directory](https://medusajs.com/plugins/), or [create your own](../../../references/notification/classes/notification.AbstractNotificationService.mdx). --- @@ -147,6 +147,6 @@ Where `` is the identifier for your notifica :::note -You can learn more about handling events with the Notification Service using [this documentation](../../../development/notification/create-notification-provider.md). +You can learn more about handling events with the Notification Service using [this documentation](../../../references/notification/classes/notification.AbstractNotificationService.mdx). ::: diff --git a/www/apps/docs/content/plugins/cms/contentful.mdx b/www/apps/docs/content/plugins/cms/contentful.mdx index 1b839a397e..eed9076620 100644 --- a/www/apps/docs/content/plugins/cms/contentful.mdx +++ b/www/apps/docs/content/plugins/cms/contentful.mdx @@ -20,7 +20,7 @@ By integrating Contentful to Medusa, you can benefit from powerful features in y This guide assumes you already have a Medusa backend installed. If not, you can learn how to install it [here](../../create-medusa-app.mdx). -Redis must also be configured in your Medusa backend if you want to sync data from Medusa to Contentful. Learn how to configure it [here](../../development/backend/configurations.md#redis_url). +Redis must also be configured in your Medusa backend if you want to sync data from Medusa to Contentful. Learn how to configure it [here](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx#redis_url). ### Needed Account diff --git a/www/apps/docs/content/plugins/cms/strapi.md b/www/apps/docs/content/plugins/cms/strapi.md index 81be649f03..69b3990ceb 100644 --- a/www/apps/docs/content/plugins/cms/strapi.md +++ b/www/apps/docs/content/plugins/cms/strapi.md @@ -99,8 +99,8 @@ cd medusa-backend You must then configure your backend to: -- Connect to a PostgreSQL database, as explained [here](../../development/backend/configurations.md#database-configuration) -- Install and configure an event-bus module, as explained [here](../../development/backend/configurations.md#recommended-event-bus-modules) +- Connect to a PostgreSQL database, as explained [here](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx#database-configuration) +- Install and configure an event-bus module, as explained [here](../../references/medusa_config/interfaces/medusa_config.ConfigModule.mdx#recommended-event-bus-modules) ### Run Migrations diff --git a/www/apps/docs/content/plugins/file-service/index.mdx b/www/apps/docs/content/plugins/file-service/index.mdx index 415edbcbb2..da79c87719 100644 --- a/www/apps/docs/content/plugins/file-service/index.mdx +++ b/www/apps/docs/content/plugins/file-service/index.mdx @@ -2,6 +2,6 @@ import DocCardList from '@theme/DocCardList'; # File Service Plugins -If you can't find your file service or storage provider, try checking the [Community Plugins Library](https://medusajs.com/plugins/?filters=Storage&categories=Storage). You can also [create your own file service](../../development/file-service/create-file-service.md). +If you can't find your file service or storage provider, try checking the [Community Plugins Library](https://medusajs.com/plugins/?filters=Storage&categories=Storage). You can also [create your own file service](../../references/file/classes/file.AbstractFileService.mdx). \ No newline at end of file diff --git a/www/apps/docs/content/plugins/notifications/index.mdx b/www/apps/docs/content/plugins/notifications/index.mdx index 8d175c867e..32a7a112d0 100644 --- a/www/apps/docs/content/plugins/notifications/index.mdx +++ b/www/apps/docs/content/plugins/notifications/index.mdx @@ -2,6 +2,6 @@ import DocCardList from '@theme/DocCardList'; # Notifications Plugins -If you can't find your notification provider, try checking the [Community Plugins Library](https://medusajs.com/plugins/?filters=Notification&categories=Notification). You can also [create your own notification service](../../development/notification/create-notification-provider.md). +If you can't find your notification provider, try checking the [Community Plugins Library](https://medusajs.com/plugins/?filters=Notification&categories=Notification). You can also [create your own notification service](../../references/notification/classes/notification.AbstractNotificationService.mdx). \ No newline at end of file diff --git a/www/apps/docs/content/plugins/search/index.mdx b/www/apps/docs/content/plugins/search/index.mdx index 5a1365031e..ce5d225ee0 100644 --- a/www/apps/docs/content/plugins/search/index.mdx +++ b/www/apps/docs/content/plugins/search/index.mdx @@ -2,6 +2,6 @@ import DocCardList from '@theme/DocCardList'; # Search Plugins -If you can't find your search provider, try checking the [Community Plugins Library](https://medusajs.com/plugins/?filters=Search&categories=Search). You can also [create your own search service](../../development/search/create.md). +If you can't find your search provider, try checking the [Community Plugins Library](https://medusajs.com/plugins/?filters=Search&categories=Search). You can also [create your own search service](../../references/search/classes/search.AbstractSearchService.mdx). \ No newline at end of file diff --git a/www/apps/docs/content/references/entities/classes/entities.BatchJob.mdx b/www/apps/docs/content/references/entities/classes/entities.BatchJob.mdx index 15e8e7f360..7dba77933f 100644 --- a/www/apps/docs/content/references/entities/classes/entities.BatchJob.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.BatchJob.mdx @@ -11,4 +11,4 @@ A Batch Job indicates an asynchronus task stored in the Medusa backend. Its stat ## Properties -`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROCESSING","type":"`\"processing\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date of the concellation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date of the completion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date when the confirmation has been done.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`Date`","description":"The date when the job failed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`Date`","description":"The date from which the job has been pre-processed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"processing_at","type":"`Date`","description":"The date the job is processing at.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> +`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROCESSING","type":"`\"processing\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date of the concellation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date of the completion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date when the confirmation has been done.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`Date`","description":"The date when the job failed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`Date`","description":"The date from which the job has been pre-processed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"processing_at","type":"`Date`","description":"The date the job is processing at.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/classes/entities.PriceList.mdx b/www/apps/docs/content/references/entities/classes/entities.PriceList.mdx index f972e6d960..416ab85f5b 100644 --- a/www/apps/docs/content/references/entities/classes/entities.PriceList.mdx +++ b/www/apps/docs/content/references/entities/classes/entities.PriceList.mdx @@ -11,4 +11,4 @@ A Price List represents a set of prices that override the default price for one ## Properties -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[{"name":"OVERRIDE","type":"`\"override\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"SALE","type":"`\"sale\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](entities.ProductVariant.mdx)","description":"The details of the product variant that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](entities.Currency.mdx)","description":"The details of the currency that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](entities.Region.mdx)","description":"The details of the region that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[{"name":"SALE","type":"`\"sale\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OVERRIDE","type":"`\"override\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/development/entities/repositories#retrieving-a-list-of-records"/> diff --git a/www/apps/docs/content/references/entities/enums/entities.AllocationType.mdx b/www/apps/docs/content/references/entities/enums/entities.AllocationType.mdx index cb71377b53..a575871ea5 100644 --- a/www/apps/docs/content/references/entities/enums/entities.AllocationType.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.AllocationType.mdx @@ -16,8 +16,6 @@ The scope that the discount should apply to. The discount should be applied to applicable items in the cart. -___ - ### TOTAL **TOTAL** = `"total"` diff --git a/www/apps/docs/content/references/entities/enums/entities.CartType.mdx b/www/apps/docs/content/references/entities/enums/entities.CartType.mdx index c78f78f7ce..8e62c08a3c 100644 --- a/www/apps/docs/content/references/entities/enums/entities.CartType.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.CartType.mdx @@ -12,26 +12,18 @@ import ParameterTypes from "@site/src/components/ParameterTypes" **CLAIM** = `"claim"` -___ - ### DEFAULT **DEFAULT** = `"default"` -___ - ### DRAFT\_ORDER **DRAFT\_ORDER** = `"draft_order"` -___ - ### PAYMENT\_LINK **PAYMENT\_LINK** = `"payment_link"` -___ - ### SWAP **SWAP** = `"swap"` diff --git a/www/apps/docs/content/references/entities/enums/entities.ClaimFulfillmentStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.ClaimFulfillmentStatus.mdx index 9640e72599..1862aa0f21 100644 --- a/www/apps/docs/content/references/entities/enums/entities.ClaimFulfillmentStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.ClaimFulfillmentStatus.mdx @@ -16,64 +16,48 @@ The claim's fulfillment status. The claim's fulfillments are canceled. -___ - ### FULFILLED **FULFILLED** = `"fulfilled"` The claim's replacement items are fulfilled. -___ - ### NOT\_FULFILLED **NOT\_FULFILLED** = `"not_fulfilled"` The claim's replacement items are not fulfilled. -___ - ### PARTIALLY\_FULFILLED **PARTIALLY\_FULFILLED** = `"partially_fulfilled"` Some of the claim's replacement items, but not all, are fulfilled. -___ - ### PARTIALLY\_RETURNED **PARTIALLY\_RETURNED** = `"partially_returned"` Some of the claim's items, but not all, are returned. -___ - ### PARTIALLY\_SHIPPED **PARTIALLY\_SHIPPED** = `"partially_shipped"` Some of the claim's replacement items, but not all, are shipped. -___ - ### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` The claim's fulfillment requires action. -___ - ### RETURNED **RETURNED** = `"returned"` The claim's items are returned. -___ - ### SHIPPED **SHIPPED** = `"shipped"` diff --git a/www/apps/docs/content/references/entities/enums/entities.ClaimPaymentStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.ClaimPaymentStatus.mdx index 4a7aabbcac..aa1e361ebe 100644 --- a/www/apps/docs/content/references/entities/enums/entities.ClaimPaymentStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.ClaimPaymentStatus.mdx @@ -16,16 +16,12 @@ The claim's payment status The payment status isn't set, which is typically used when the claim's type is `replace`. -___ - ### NOT\_REFUNDED **NOT\_REFUNDED** = `"not_refunded"` The payment isn't refunded. -___ - ### REFUNDED **REFUNDED** = `"refunded"` diff --git a/www/apps/docs/content/references/entities/enums/entities.ClaimReason.mdx b/www/apps/docs/content/references/entities/enums/entities.ClaimReason.mdx index 6300920b54..e08bf94a6d 100644 --- a/www/apps/docs/content/references/entities/enums/entities.ClaimReason.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.ClaimReason.mdx @@ -12,20 +12,14 @@ import ParameterTypes from "@site/src/components/ParameterTypes" **MISSING\_ITEM** = `"missing_item"` -___ - ### OTHER **OTHER** = `"other"` -___ - ### PRODUCTION\_FAILURE **PRODUCTION\_FAILURE** = `"production_failure"` -___ - ### WRONG\_ITEM **WRONG\_ITEM** = `"wrong_item"` diff --git a/www/apps/docs/content/references/entities/enums/entities.ClaimType.mdx b/www/apps/docs/content/references/entities/enums/entities.ClaimType.mdx index 23eabada69..5de920aa80 100644 --- a/www/apps/docs/content/references/entities/enums/entities.ClaimType.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.ClaimType.mdx @@ -16,8 +16,6 @@ The claim's type. The claim refunds an amount to the customer. -___ - ### REPLACE **REPLACE** = `"replace"` diff --git a/www/apps/docs/content/references/entities/enums/entities.DiscountConditionOperator.mdx b/www/apps/docs/content/references/entities/enums/entities.DiscountConditionOperator.mdx index d4146cca85..f8da357bc2 100644 --- a/www/apps/docs/content/references/entities/enums/entities.DiscountConditionOperator.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.DiscountConditionOperator.mdx @@ -16,8 +16,6 @@ The possible operators used for a discount condition. The discountable resources are within the specified resources. -___ - ### NOT\_IN **NOT\_IN** = `"not_in"` diff --git a/www/apps/docs/content/references/entities/enums/entities.DiscountConditionType.mdx b/www/apps/docs/content/references/entities/enums/entities.DiscountConditionType.mdx index cd13c91243..a2761f8d21 100644 --- a/www/apps/docs/content/references/entities/enums/entities.DiscountConditionType.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.DiscountConditionType.mdx @@ -16,32 +16,24 @@ The discount condition's type. The discount condition is used for customer groups. -___ - ### PRODUCTS **PRODUCTS** = `"products"` The discount condition is used for products. -___ - ### PRODUCT\_COLLECTIONS **PRODUCT\_COLLECTIONS** = `"product_collections"` The discount condition is used for product collections. -___ - ### PRODUCT\_TAGS **PRODUCT\_TAGS** = `"product_tags"` The discount condition is used for product tags. -___ - ### PRODUCT\_TYPES **PRODUCT\_TYPES** = `"product_types"` diff --git a/www/apps/docs/content/references/entities/enums/entities.DiscountRuleType.mdx b/www/apps/docs/content/references/entities/enums/entities.DiscountRuleType.mdx index 7905738dfd..122e2a9dc2 100644 --- a/www/apps/docs/content/references/entities/enums/entities.DiscountRuleType.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.DiscountRuleType.mdx @@ -16,16 +16,12 @@ The possible types of discount rules. Discounts that reduce the price by a fixed amount. -___ - ### FREE\_SHIPPING **FREE\_SHIPPING** = `"free_shipping"` Discounts that sets the shipping price to `0`. -___ - ### PERCENTAGE **PERCENTAGE** = `"percentage"` diff --git a/www/apps/docs/content/references/entities/enums/entities.DraftOrderStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.DraftOrderStatus.mdx index 87026819d2..4ec51c3d80 100644 --- a/www/apps/docs/content/references/entities/enums/entities.DraftOrderStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.DraftOrderStatus.mdx @@ -16,8 +16,6 @@ The draft order's status. The draft order is completed, and an order has been created from it. -___ - ### OPEN **OPEN** = `"open"` diff --git a/www/apps/docs/content/references/entities/enums/entities.FulfillmentStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.FulfillmentStatus.mdx index 560234d78a..213ad9d184 100644 --- a/www/apps/docs/content/references/entities/enums/entities.FulfillmentStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.FulfillmentStatus.mdx @@ -16,64 +16,48 @@ The order's fulfillment status. The order's fulfillments are canceled. -___ - ### FULFILLED **FULFILLED** = `"fulfilled"` The order's items are fulfilled. -___ - ### NOT\_FULFILLED **NOT\_FULFILLED** = `"not_fulfilled"` The order's items are not fulfilled. -___ - ### PARTIALLY\_FULFILLED **PARTIALLY\_FULFILLED** = `"partially_fulfilled"` Some of the order's items, but not all, are fulfilled. -___ - ### PARTIALLY\_RETURNED **PARTIALLY\_RETURNED** = `"partially_returned"` Some of the order's items, but not all, are returned. -___ - ### PARTIALLY\_SHIPPED **PARTIALLY\_SHIPPED** = `"partially_shipped"` Some of the order's items, but not all, are shipped. -___ - ### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` The order's fulfillment requires action. -___ - ### RETURNED **RETURNED** = `"returned"` The order's items are returned. -___ - ### SHIPPED **SHIPPED** = `"shipped"` diff --git a/www/apps/docs/content/references/entities/enums/entities.OrderEditItemChangeType.mdx b/www/apps/docs/content/references/entities/enums/entities.OrderEditItemChangeType.mdx index 92c6cabab5..d2e6aff7ea 100644 --- a/www/apps/docs/content/references/entities/enums/entities.OrderEditItemChangeType.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.OrderEditItemChangeType.mdx @@ -16,16 +16,12 @@ The type of the order edit item change. A new item to be added to the original order. -___ - ### ITEM\_REMOVE **ITEM\_REMOVE** = `"item_remove"` An existing item to be removed from the original order. -___ - ### ITEM\_UPDATE **ITEM\_UPDATE** = `"item_update"` diff --git a/www/apps/docs/content/references/entities/enums/entities.OrderEditStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.OrderEditStatus.mdx index e965d5f26b..e55285f931 100644 --- a/www/apps/docs/content/references/entities/enums/entities.OrderEditStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.OrderEditStatus.mdx @@ -16,32 +16,24 @@ The order edit's status. The order edit is canceled. -___ - ### CONFIRMED **CONFIRMED** = `"confirmed"` The order edit is confirmed. -___ - ### CREATED **CREATED** = `"created"` The order edit is created. -___ - ### DECLINED **DECLINED** = `"declined"` The order edit is declined. -___ - ### REQUESTED **REQUESTED** = `"requested"` diff --git a/www/apps/docs/content/references/entities/enums/entities.OrderStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.OrderStatus.mdx index 3e5a56c996..7534ae55f2 100644 --- a/www/apps/docs/content/references/entities/enums/entities.OrderStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.OrderStatus.mdx @@ -16,16 +16,12 @@ The order's status. The order is archived. -___ - ### CANCELED **CANCELED** = `"canceled"` The order is canceled. -___ - ### COMPLETED **COMPLETED** = `"completed"` @@ -34,16 +30,12 @@ The order is completed, meaning that the items have been fulfilled and the payment has been captured. -___ - ### PENDING **PENDING** = `"pending"` The order is pending. -___ - ### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` diff --git a/www/apps/docs/content/references/entities/enums/entities.PaymentCollectionStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.PaymentCollectionStatus.mdx index 5f0e6ffb4f..c07291e8b2 100644 --- a/www/apps/docs/content/references/entities/enums/entities.PaymentCollectionStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.PaymentCollectionStatus.mdx @@ -16,32 +16,24 @@ The payment collection's status. The payment colleciton is authorized. -___ - ### AWAITING **AWAITING** = `"awaiting"` The payment collection is awaiting payment. -___ - ### CANCELED **CANCELED** = `"canceled"` The payment collection is canceled. -___ - ### NOT\_PAID **NOT\_PAID** = `"not_paid"` The payment collection isn't paid. -___ - ### PARTIALLY\_AUTHORIZED **PARTIALLY\_AUTHORIZED** = `"partially_authorized"` diff --git a/www/apps/docs/content/references/entities/enums/entities.PaymentSessionStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.PaymentSessionStatus.mdx index eba6de2ff7..5fe264fd60 100644 --- a/www/apps/docs/content/references/entities/enums/entities.PaymentSessionStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.PaymentSessionStatus.mdx @@ -16,32 +16,24 @@ The status of a payment session. The payment is authorized. -___ - ### CANCELED **CANCELED** = `"canceled"` The payment is canceled. -___ - ### ERROR **ERROR** = `"error"` An error occurred while processing the payment. -___ - ### PENDING **PENDING** = `"pending"` The payment is pending. -___ - ### REQUIRES\_MORE **REQUIRES\_MORE** = `"requires_more"` diff --git a/www/apps/docs/content/references/entities/enums/entities.PaymentStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.PaymentStatus.mdx index f1e020cb06..f87215141a 100644 --- a/www/apps/docs/content/references/entities/enums/entities.PaymentStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.PaymentStatus.mdx @@ -16,48 +16,36 @@ The order's payment status. The order's payment is awaiting capturing. -___ - ### CANCELED **CANCELED** = `"canceled"` The order's payment is canceled. -___ - ### CAPTURED **CAPTURED** = `"captured"` The order's payment is captured. -___ - ### NOT\_PAID **NOT\_PAID** = `"not_paid"` The order's payment is not paid. -___ - ### PARTIALLY\_REFUNDED **PARTIALLY\_REFUNDED** = `"partially_refunded"` Some of the order's payment amount is refunded. -___ - ### REFUNDED **REFUNDED** = `"refunded"` The order's payment amount is refunded. -___ - ### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` diff --git a/www/apps/docs/content/references/entities/enums/entities.ProductStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.ProductStatus.mdx index 0f7c8b46df..77bb3ce59c 100644 --- a/www/apps/docs/content/references/entities/enums/entities.ProductStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.ProductStatus.mdx @@ -16,24 +16,18 @@ The status of a product. The product is a draft. It's not viewable by customers. -___ - ### PROPOSED **PROPOSED** = `"proposed"` The product is proposed, but not yet published. -___ - ### PUBLISHED **PUBLISHED** = `"published"` The product is published. -___ - ### REJECTED **REJECTED** = `"rejected"` diff --git a/www/apps/docs/content/references/entities/enums/entities.RefundReason.mdx b/www/apps/docs/content/references/entities/enums/entities.RefundReason.mdx index 1ca51325cb..2373f1f450 100644 --- a/www/apps/docs/content/references/entities/enums/entities.RefundReason.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.RefundReason.mdx @@ -16,32 +16,24 @@ The reason of the refund. The refund is applied because of a created claim. -___ - ### DISCOUNT **DISCOUNT** = `"discount"` The refund is applied as a discount. -___ - ### OTHER **OTHER** = `"other"` The refund is created for a custom reason. -___ - ### RETURN **RETURN** = `"return"` The refund is applied because of a created return. -___ - ### SWAP **SWAP** = `"swap"` diff --git a/www/apps/docs/content/references/entities/enums/entities.RequirementType.mdx b/www/apps/docs/content/references/entities/enums/entities.RequirementType.mdx index 8c9caa134a..78aba5b3cb 100644 --- a/www/apps/docs/content/references/entities/enums/entities.RequirementType.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.RequirementType.mdx @@ -16,8 +16,6 @@ The type of shipping option requirement. The shipping option can only be applied if the subtotal is less than the requirement's amont. -___ - ### MIN\_SUBTOTAL **MIN\_SUBTOTAL** = `"min_subtotal"` diff --git a/www/apps/docs/content/references/entities/enums/entities.ReturnStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.ReturnStatus.mdx index 7d86a5fe10..38e33caa10 100644 --- a/www/apps/docs/content/references/entities/enums/entities.ReturnStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.ReturnStatus.mdx @@ -16,24 +16,18 @@ The return's status. The return is canceled. -___ - ### RECEIVED **RECEIVED** = `"received"` The return is received. -___ - ### REQUESTED **REQUESTED** = `"requested"` The return is requested. -___ - ### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` diff --git a/www/apps/docs/content/references/entities/enums/entities.ShippingOptionPriceType.mdx b/www/apps/docs/content/references/entities/enums/entities.ShippingOptionPriceType.mdx index fb58a0f17b..57a3b18bb4 100644 --- a/www/apps/docs/content/references/entities/enums/entities.ShippingOptionPriceType.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.ShippingOptionPriceType.mdx @@ -16,8 +16,6 @@ The type of the shipping option price. The shipping option's price is calculated. In this case, the `amount` field is typically `null`. -___ - ### FLAT\_RATE **FLAT\_RATE** = `"flat_rate"` diff --git a/www/apps/docs/content/references/entities/enums/entities.ShippingProfileType.mdx b/www/apps/docs/content/references/entities/enums/entities.ShippingProfileType.mdx index eb986e3d76..06a50e9021 100644 --- a/www/apps/docs/content/references/entities/enums/entities.ShippingProfileType.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.ShippingProfileType.mdx @@ -16,16 +16,12 @@ The shipping profile's type. The profile used to ship custom items. -___ - ### DEFAULT **DEFAULT** = `"default"` The default profile used to ship item. -___ - ### GIFT\_CARD **GIFT\_CARD** = `"gift_card"` diff --git a/www/apps/docs/content/references/entities/enums/entities.SwapFulfillmentStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.SwapFulfillmentStatus.mdx index 2997ee1d1b..e6e3c2b3df 100644 --- a/www/apps/docs/content/references/entities/enums/entities.SwapFulfillmentStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.SwapFulfillmentStatus.mdx @@ -16,40 +16,30 @@ The swap's fulfillment status. The swap's fulfillments are canceled. -___ - ### FULFILLED **FULFILLED** = `"fulfilled"` The swap's items are fulfilled. -___ - ### NOT\_FULFILLED **NOT\_FULFILLED** = `"not_fulfilled"` The swap's items aren't fulfilled. -___ - ### PARTIALLY\_SHIPPED **PARTIALLY\_SHIPPED** = `"partially_shipped"` Some of the swap's items are shipped. -___ - ### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` The swap's fulfillments require an action. -___ - ### SHIPPED **SHIPPED** = `"shipped"` diff --git a/www/apps/docs/content/references/entities/enums/entities.SwapPaymentStatus.mdx b/www/apps/docs/content/references/entities/enums/entities.SwapPaymentStatus.mdx index 3804a0f19c..5a8750d71b 100644 --- a/www/apps/docs/content/references/entities/enums/entities.SwapPaymentStatus.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.SwapPaymentStatus.mdx @@ -16,64 +16,48 @@ The swap's payment status. The swap is additional awaiting payment. -___ - ### CANCELED **CANCELED** = `"canceled"` The swap's additional payment is canceled. -___ - ### CAPTURED **CAPTURED** = `"captured"` The swap's additional payment is captured. -___ - ### CONFIRMED **CONFIRMED** = `"confirmed"` The swap's additional payment is confirmed. -___ - ### DIFFERENCE\_REFUNDED **DIFFERENCE\_REFUNDED** = `"difference_refunded"` The negative difference amount between the returned item(s) and the new one(s) has been refuneded. -___ - ### NOT\_PAID **NOT\_PAID** = `"not_paid"` The swap's additional payment isn't paid. -___ - ### PARTIALLY\_REFUNDED **PARTIALLY\_REFUNDED** = `"partially_refunded"` Some of the negative difference amount between the returned item(s) and the new one(s) has been refuneded. -___ - ### REFUNDED **REFUNDED** = `"refunded"` The amount in the associated order has been refunded. -___ - ### REQUIRES\_ACTION **REQUIRES\_ACTION** = `"requires_action"` diff --git a/www/apps/docs/content/references/entities/enums/entities.UserRoles.mdx b/www/apps/docs/content/references/entities/enums/entities.UserRoles.mdx index 52717c53c2..3188c328d0 100644 --- a/www/apps/docs/content/references/entities/enums/entities.UserRoles.mdx +++ b/www/apps/docs/content/references/entities/enums/entities.UserRoles.mdx @@ -16,16 +16,12 @@ The user's role. These roles don't change the user's capabilities or provide acc The user is an admin. -___ - ### DEVELOPER **DEVELOPER** = `"developer"` The user is a developer. -___ - ### MEMBER **MEMBER** = `"member"` diff --git a/www/apps/docs/content/references/file/classes/file.AbstractFileService.mdx b/www/apps/docs/content/references/file/classes/file.AbstractFileService.mdx new file mode 100644 index 0000000000..8fcaaf82ea --- /dev/null +++ b/www/apps/docs/content/references/file/classes/file.AbstractFileService.mdx @@ -0,0 +1,380 @@ +--- +displayed_sidebar: core +slug: /development/file-service/create-file-service +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# How to Create a File Service + +In this document, you’ll learn how to create a file service in the Medusa backend and the methods you must implement in it. + +## Overview + +A file service class is defined in a TypeScript or JavaScript file that’s created in the `src/services` directory. +The class must extend the `AbstractFileService` class imported from the `@medusajs/medusa` package. + +Based on services’ naming conventions, the file’s name should be the slug version of the file service’s name +without `service`, and the class’s name should be the pascal case of the file service’s name following by `Service`. + +For example, create the file `src/services/local-file.ts` with the following content: + +```ts title="src/services/local-file.ts" +import { AbstractFileService } from "@medusajs/medusa" +import { + DeleteFileType, + FileServiceGetUploadStreamResult, + FileServiceUploadResult, + GetUploadedFileType, + UploadStreamDescriptorType, +} from "@medusajs/types" + +class LocalFileService extends AbstractFileService { + async upload( + fileData: Express.Multer.File + ): Promise { + throw new Error("Method not implemented.") + } + async uploadProtected( + fileData: Express.Multer.File + ): Promise { + throw new Error("Method not implemented.") + } + async delete(fileData: DeleteFileType): Promise { + throw new Error("Method not implemented.") + } + async getUploadStreamDescriptor( + fileData: UploadStreamDescriptorType + ): Promise { + throw new Error("Method not implemented.") + } + async getDownloadStream( + fileData: GetUploadedFileType + ): Promise { + throw new Error("Method not implemented.") + } + async getPresignedDownloadUrl( + fileData: GetUploadedFileType + ): Promise { + throw new Error("Method not implemented.") + } +} + +export default LocalFileService +``` + +:::note[Multer Typing] + +The examples implement a file service supporting local uploads. + +If you’re using TypeScript and you're following along with the implementation, +you should install the Multer types package in the root of your Medusa backend to resolve errors within your file service types: + +```bash npm2yarn +npm install @types/multer +``` + +::: + +--- + +## constructor + +You can use the `constructor` of your file service to access the different services in Medusa through dependency injection. + +You can also use the constructor to initialize your integration with the third-party provider. For example, if you use a client to connect to the third-party provider’s APIs, +you can initialize it in the constructor and use it in other methods in the service. + +Additionally, if you’re creating your file service as an external plugin to be installed on any Medusa backend and you want to access the options added for the plugin, +you can access them in the constructor. + +### Example + +```ts +// ... +import { Logger } from "@medusajs/medusa" +import * as fs from "fs" + +class LocalFileService extends AbstractFileService { + // can also be replaced by an environment variable + // or a plugin option + protected serverUrl = "http://localhost:9000" + protected publicPath = "uploads" + protected protectedPath = "protected-uploads" + protected logger_: Logger + + constructor({ logger }: InjectedDependencies) { + // @ts-ignore + super(...arguments) + this.logger_ = logger + + // for public uploads + if (!fs.existsSync(this.publicPath)) { + fs.mkdirSync(this.publicPath) + } + + // for protected uploads + if (!fs.existsSync(this.protectedPath)) { + fs.mkdirSync(this.protectedPath) + } + } + // ... +} +``` + +### Parameters + +`","description":"If this file service is created in a plugin, the plugin's options are passed in this parameter.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} /> + +___ + +## Methods + +### upload + +This method is used to upload a file to the Medusa backend. + +#### Example + +```ts +class LocalFileService extends AbstractFileService { + // ... + async upload( + fileData: Express.Multer.File + ): Promise { + const filePath = + `${this.publicPath}/${fileData.originalname}` + fs.copyFileSync(fileData.path, filePath) + return { + url: `${this.serverUrl}/${filePath}`, + key: filePath, + } + } + // ... +} +``` + +:::tip + +This example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name. + +::: + +#### Parameters + + + +#### Returns + + + +### uploadProtected + +This method is used to upload a file to the Medusa backend, but to a protected storage. Typically, this would be used to store files that +shouldn’t be accessible by using the file’s URL or should only be accessible by authenticated users. For example, exported or imported +CSV files. + +#### Example + +```ts +class LocalFileService extends AbstractFileService { + // ... + async uploadProtected( + fileData: Express.Multer.File + ): Promise { + const filePath = + `${this.protectedPath}/${fileData.originalname}` + fs.copyFileSync(fileData.path, filePath) + return { + url: `${this.serverUrl}/${filePath}`, + key: filePath + } + } + // ... +} +``` + +:::tip + +This example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name. + +::: + +#### Parameters + + + +#### Returns + + + +### delete + +This method is used to delete a file from storage. + +#### Example + +```ts +class LocalFileService extends AbstractFileService { + + async delete( + fileData: DeleteFileType + ): Promise { + fs.rmSync(fileData.fileKey) + } + + // ... +} +``` + +#### Parameters + + + +#### Returns + + + +### getUploadStreamDescriptor + +This method is used to retrieve a write stream to be used to upload a file. + +#### Example + +```ts +// ... +import { Stream } from "stream" + +class LocalFileService extends AbstractFileService { + // ... + async getUploadStreamDescriptor({ + name, + ext, + isPrivate = true, + }: UploadStreamDescriptorType + ): Promise { + const filePath = `${isPrivate ? + this.publicPath : this.protectedPath + }/${name}.${ext}` + + const pass = new Stream.PassThrough() + const writeStream = fs.createWriteStream(filePath) + + pass.pipe(writeStream) + + return { + writeStream: pass, + promise: Promise.resolve(), + url: `${this.serverUrl}/${filePath}`, + fileKey: filePath, + } + } + // ... +} +``` + +#### Parameters + + + +#### Returns + + + +### getDownloadStream + +This method is used to retrieve a read stream for a file, which can then be used to download the file. + +#### Example + +```ts +class LocalFileService extends AbstractFileService { + + async getDownloadStream({ + fileKey, + isPrivate = true, + }: GetUploadedFileType + ): Promise { + const filePath = `${isPrivate ? + this.publicPath : this.protectedPath + }/${fileKey}` + const readStream = fs.createReadStream(filePath) + + return readStream + } + + // ... +} +``` + +#### Parameters + + + +#### Returns + + + +### getPresignedDownloadUrl + +This method is used to retrieve a download URL of the file. For some file services, such as S3, a presigned URL indicates a temporary URL to get access to a file. + +If your file service doesn’t perform or offer a similar functionality, you can just return the URL to download the file. + +#### Example + +```ts +class LocalFileService extends AbstractFileService { + + async getPresignedDownloadUrl({ + fileKey, + isPrivate = true, + }: GetUploadedFileType + ): Promise { + // Local upload doesn't provide + // support for presigned URLs, + // so just return the file's URL. + + const filePath = `${isPrivate ? + this.publicPath : this.protectedPath + }/${fileKey}` + return `${this.serverUrl}/${filePath}` + } + + // ... +} +``` + +#### Parameters + + + +#### Returns + + + +--- + +## Test Implementation + +:::note + +If you created your file service in a plugin, refer to [this guide on how to test plugins](https://docs.medusajs.com/development/plugins/create#test-your-plugin). + +::: + +After finishing your file service implementation: + +1\. Run the `build` command in the root of your Medusa backend: + +```bash npm2yarn +npm run build +``` + +2\. Start the backend with the `develop` command: + +```bash +npx medusa develop +``` + +3\. Upload a file using the [Admin REST APIs](https://docs.medusajs.com/api/admin#uploads_postuploads) or using the Medusa admin, for example, to [upload a product's thumbnail](https://docs.medusajs.com/user-guide/products/manage#manage-thumbnails). diff --git a/www/apps/docs/content/references/file/interfaces/file.IFileService.mdx b/www/apps/docs/content/references/file/interfaces/file.IFileService.mdx new file mode 100644 index 0000000000..aad3b51622 --- /dev/null +++ b/www/apps/docs/content/references/file/interfaces/file.IFileService.mdx @@ -0,0 +1,355 @@ +--- +displayed_sidebar: core +--- + +import ParameterTypes from "@site/src/components/ParameterTypes" + +# IFileService + +## Overview + +A file service class is defined in a TypeScript or JavaScript file that’s created in the `src/services` directory. +The class must extend the `AbstractFileService` class imported from the `@medusajs/medusa` package. + +Based on services’ naming conventions, the file’s name should be the slug version of the file service’s name +without `service`, and the class’s name should be the pascal case of the file service’s name following by `Service`. + +For example, create the file `src/services/local-file.ts` with the following content: + +```ts title="src/services/local-file.ts" +import { AbstractFileService } from "@medusajs/medusa" +import { + DeleteFileType, + FileServiceGetUploadStreamResult, + FileServiceUploadResult, + GetUploadedFileType, + UploadStreamDescriptorType, +} from "@medusajs/types" + +class LocalFileService extends AbstractFileService { + async upload( + fileData: Express.Multer.File + ): Promise { + throw new Error("Method not implemented.") + } + async uploadProtected( + fileData: Express.Multer.File + ): Promise { + throw new Error("Method not implemented.") + } + async delete(fileData: DeleteFileType): Promise { + throw new Error("Method not implemented.") + } + async getUploadStreamDescriptor( + fileData: UploadStreamDescriptorType + ): Promise { + throw new Error("Method not implemented.") + } + async getDownloadStream( + fileData: GetUploadedFileType + ): Promise { + throw new Error("Method not implemented.") + } + async getPresignedDownloadUrl( + fileData: GetUploadedFileType + ): Promise { + throw new Error("Method not implemented.") + } +} + +export default LocalFileService +``` + +:::note[Multer Typing] + +The examples implement a file service supporting local uploads. + +If you’re using TypeScript and you're following along with the implementation, +you should install the Multer types package in the root of your Medusa backend to resolve errors within your file service types: + +```bash npm2yarn +npm install @types/multer +``` + +::: + +--- + +## Properties + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} /> + +___ + +## Accessors + +### activeManager\_ + +#### Returns + + + +___ + +## Methods + +### upload + +This method is used to upload a file to the Medusa backend. + +#### Example + +```ts +class LocalFileService extends AbstractFileService { + // ... + async upload( + fileData: Express.Multer.File + ): Promise { + const filePath = + `${this.publicPath}/${fileData.originalname}` + fs.copyFileSync(fileData.path, filePath) + return { + url: `${this.serverUrl}/${filePath}`, + key: filePath, + } + } + // ... +} +``` + +:::tip + +This example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name. + +::: + +#### Parameters + + + +#### Returns + + + +### uploadProtected + +This method is used to upload a file to the Medusa backend, but to a protected storage. Typically, this would be used to store files that +shouldn’t be accessible by using the file’s URL or should only be accessible by authenticated users. For example, exported or imported +CSV files. + +#### Example + +```ts +class LocalFileService extends AbstractFileService { + // ... + async uploadProtected( + fileData: Express.Multer.File + ): Promise { + const filePath = + `${this.protectedPath}/${fileData.originalname}` + fs.copyFileSync(fileData.path, filePath) + return { + url: `${this.serverUrl}/${filePath}`, + key: filePath + } + } + // ... +} +``` + +:::tip + +This example does not account for duplicate names to maintain simplicity in this guide. So, an uploaded file can replace another existing file that has the same name. + +::: + +#### Parameters + + + +#### Returns + + + +### delete + +This method is used to delete a file from storage. + +#### Example + +```ts +class LocalFileService extends AbstractFileService { + + async delete( + fileData: DeleteFileType + ): Promise { + fs.rmSync(fileData.fileKey) + } + + // ... +} +``` + +#### Parameters + + + +#### Returns + + + +### getUploadStreamDescriptor + +This method is used to retrieve a write stream to be used to upload a file. + +#### Example + +```ts +// ... +import { Stream } from "stream" + +class LocalFileService extends AbstractFileService { + // ... + async getUploadStreamDescriptor({ + name, + ext, + isPrivate = true, + }: UploadStreamDescriptorType + ): Promise { + const filePath = `${isPrivate ? + this.publicPath : this.protectedPath + }/${name}.${ext}` + + const pass = new Stream.PassThrough() + const writeStream = fs.createWriteStream(filePath) + + pass.pipe(writeStream) + + return { + writeStream: pass, + promise: Promise.resolve(), + url: `${this.serverUrl}/${filePath}`, + fileKey: filePath, + } + } + // ... +} +``` + +#### Parameters + + + +#### Returns + + + +### getDownloadStream + +This method is used to retrieve a read stream for a file, which can then be used to download the file. + +#### Example + +```ts +class LocalFileService extends AbstractFileService { + + async getDownloadStream({ + fileKey, + isPrivate = true, + }: GetUploadedFileType + ): Promise { + const filePath = `${isPrivate ? + this.publicPath : this.protectedPath + }/${fileKey}` + const readStream = fs.createReadStream(filePath) + + return readStream + } + + // ... +} +``` + +#### Parameters + + + +#### Returns + + + +### getPresignedDownloadUrl + +This method is used to retrieve a download URL of the file. For some file services, such as S3, a presigned URL indicates a temporary URL to get access to a file. + +If your file service doesn’t perform or offer a similar functionality, you can just return the URL to download the file. + +#### Example + +```ts +class LocalFileService extends AbstractFileService { + + async getPresignedDownloadUrl({ + fileKey, + isPrivate = true, + }: GetUploadedFileType + ): Promise { + // Local upload doesn't provide + // support for presigned URLs, + // so just return the file's URL. + + const filePath = `${isPrivate ? + this.publicPath : this.protectedPath + }/${fileKey}` + return `${this.serverUrl}/${filePath}` + } + + // ... +} +``` + +#### Parameters + + + +#### Returns + + + +### withTransaction + +#### Parameters + + + +#### Returns + + + +### shouldRetryTransaction\_ + +#### Parameters + +` \\| `object`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} /> + +#### Returns + + + +### atomicPhase\_ + +Wraps some work within a transactional block. If the service already has +a transaction manager attached this will be reused, otherwise a new +transaction manager is created. + +#### Type Parameters + + + +#### Parameters + + Promise<TResult>","description":"the transactional work to be done","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"isolationOrErrorHandler","type":"`IsolationLevel` \\| (`error`: TError) => Promise<void \\| TResult>","description":"the isolation level to be used for the work.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"maybeErrorHandlerOrDontFail","type":"(`error`: TError) => Promise<void \\| TResult>","description":"Potential error handler","optional":true,"defaultValue":"","expandable":false,"children":[]}]} /> + +#### Returns + + diff --git a/www/apps/docs/content/references/fulfillment/classes/fulfillment.AbstractFulfillmentService.mdx b/www/apps/docs/content/references/fulfillment/classes/fulfillment.AbstractFulfillmentService.mdx index 6c47e43616..d04dec6113 100644 --- a/www/apps/docs/content/references/fulfillment/classes/fulfillment.AbstractFulfillmentService.mdx +++ b/www/apps/docs/content/references/fulfillment/classes/fulfillment.AbstractFulfillmentService.mdx @@ -7,7 +7,7 @@ import ParameterTypes from "@site/src/components/ParameterTypes" # How to Create a Fulfillment Provider -In this document, you’ll learn how to create a fulfillment provider to a Medusa backend and the methods you must implement in it. If you’re unfamiliar with the Shipping architecture in Medusa, make sure to [check out the overview first](https://docs.medusajs.com/modules/carts-and-checkout/shipping). +In this document, you’ll learn how to create a fulfillment provider in the Medusa backend and the methods you must implement in it. If you’re unfamiliar with the Shipping architecture in Medusa, make sure to [check out the overview first](https://docs.medusajs.com/modules/carts-and-checkout/shipping). ## Overview @@ -71,7 +71,7 @@ class MyFulfillmentService extends AbstractFulfillmentService { ### Parameters -`","description":"If this fulfillment provider is created in a plugin, the plugin's options are passed in this parameter.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} /> +`","description":"If this fulfillment provider is created in a plugin, the plugin's options are passed in this parameter.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} /> ___ @@ -125,8 +125,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { -___ - ### canCalculate This method is used to determine whether a shipping option is calculated dynamically or flat rate. It is called if the `price_type` of the shipping option being created is set to calculated. @@ -152,8 +150,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { -___ - ### cancelFulfillment This method is called when a fulfillment is cancelled by the admin. This fulfillment can be for an order, a claim, or a swap. @@ -181,8 +177,6 @@ class MyFulfillmentService extends FulfillmentService { -___ - ### createFulfillment This method is used when a fulfillment is created for an order, a claim, or a swap. @@ -215,8 +209,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { `","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} /> -___ - ### createReturn Fulfillment providers can also be used to return products. A shipping option can be used for returns if the `is_return` property is true or if an admin creates a Return Shipping Option from the settings. @@ -247,8 +239,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { `","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} /> -___ - ### getFulfillmentDocuments This method is used to retrieve any documents associated with a fulfillment. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents. @@ -276,8 +266,6 @@ class MyFulfillmentService extends FulfillmentService { -___ - ### getFulfillmentOptions This method is used when retrieving the list of fulfillment options available in a region, particularly by the [List Fulfillment Options API Route](https://docs.medusajs.com/api/admin#regions\_getregionsregionfulfillmentoptions). @@ -305,8 +293,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { -___ - ### getReturnDocuments This method is used to retrieve any documents associated with a return. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents. @@ -334,8 +320,6 @@ class MyFulfillmentService extends FulfillmentService { -___ - ### getShipmentDocuments This method is used to retrieve any documents associated with a shipment. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents. @@ -363,8 +347,6 @@ class MyFulfillmentService extends FulfillmentService { -___ - ### retrieveDocuments This method is used to retrieve any documents associated with an order and its fulfillments. This method isn't used by default in the backend, but you can use it for @@ -394,8 +376,6 @@ class MyFulfillmentService extends FulfillmentService { -___ - ### validateFulfillmentData This method is called when a shipping method is created. This typically happens when the customer chooses a shipping option during checkout, when a shipping method is created @@ -435,8 +415,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { `","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} /> -___ - ### validateOption Once the admin creates the shipping option, the data of the shipping option will be validated first using this method. This method is called when the [Create Shipping Option API Route](https://docs.medusajs.com/api/admin#shipping-options\_postshippingoptions) is used. @@ -463,3 +441,31 @@ class MyFulfillmentService extends AbstractFulfillmentService { #### Returns + +--- + +## Test Implementation + +:::note + +If you created your fulfillment provider in a plugin, refer to [this guide on how to test plugins](https://docs.medusajs.com/development/plugins/create#test-your-plugin). + +::: + +After finishing your fulfillment provider implementation: + +1\. Run the `build` command in the root of your Medusa backend: + +```bash npm2yarn +npm run build +``` + +2\. Start the backend with the `develop` command: + +```bash +npx medusa develop +``` + +3\. Enable your fulfillment provider in one or more regions. You can do that either using the [Admin APIs](https://docs.medusajs.com/api/admin#regions_postregionsregionfulfillmentproviders) or the [Medusa Admin](https://docs.medusajs.com/user-guide/regions/providers#manage-fulfillment-providers). + +4\. To test out your fulfillment provider implementation, create a cart and complete an order. You can do that either using the [Next.js starter](https://docs.medusajs.com/starters/nextjs-medusa-starter) or [using Medusa's APIs and clients](https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart). diff --git a/www/apps/docs/content/references/fulfillment/interfaces/fulfillment.FulfillmentService.mdx b/www/apps/docs/content/references/fulfillment/interfaces/fulfillment.FulfillmentService.mdx index a3528912b0..4a8c5bed09 100644 --- a/www/apps/docs/content/references/fulfillment/interfaces/fulfillment.FulfillmentService.mdx +++ b/www/apps/docs/content/references/fulfillment/interfaces/fulfillment.FulfillmentService.mdx @@ -43,6 +43,12 @@ class MyFulfillmentService extends AbstractFulfillmentService { --- +## Properties + +`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"__moduleDeclaration__","type":"`Record`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} /> + +___ + ## Accessors ### activeManager\_ @@ -73,8 +79,6 @@ transaction manager is created. -___ - ### calculatePrice This method is used in different places, including: @@ -123,8 +127,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { -___ - ### canCalculate This method is used to determine whether a shipping option is calculated dynamically or flat rate. It is called if the `price_type` of the shipping option being created is set to calculated. @@ -150,8 +152,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { -___ - ### cancelFulfillment This method is called when a fulfillment is cancelled by the admin. This fulfillment can be for an order, a claim, or a swap. @@ -179,8 +179,6 @@ class MyFulfillmentService extends FulfillmentService { -___ - ### createFulfillment This method is used when a fulfillment is created for an order, a claim, or a swap. @@ -213,8 +211,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { `","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} /> -___ - ### createReturn Fulfillment providers can also be used to return products. A shipping option can be used for returns if the `is_return` property is true or if an admin creates a Return Shipping Option from the settings. @@ -245,8 +241,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { `","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} /> -___ - ### getFulfillmentDocuments This method is used to retrieve any documents associated with a fulfillment. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents. @@ -274,8 +268,6 @@ class MyFulfillmentService extends FulfillmentService { -___ - ### getFulfillmentOptions This method is used when retrieving the list of fulfillment options available in a region, particularly by the [List Fulfillment Options API Route](https://docs.medusajs.com/api/admin#regions\_getregionsregionfulfillmentoptions). @@ -303,8 +295,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { -___ - ### getReturnDocuments This method is used to retrieve any documents associated with a return. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents. @@ -332,8 +322,6 @@ class MyFulfillmentService extends FulfillmentService { -___ - ### getShipmentDocuments This method is used to retrieve any documents associated with a shipment. This method isn't used by default in the backend, but you can use it for custom use cases such as allowing admins to download these documents. @@ -361,8 +349,6 @@ class MyFulfillmentService extends FulfillmentService { -___ - ### retrieveDocuments This method is used to retrieve any documents associated with an order and its fulfillments. This method isn't used by default in the backend, but you can use it for @@ -392,8 +378,6 @@ class MyFulfillmentService extends FulfillmentService { -___ - ### shouldRetryTransaction\_ #### Parameters @@ -404,8 +388,6 @@ ___ -___ - ### validateFulfillmentData This method is called when a shipping method is created. This typically happens when the customer chooses a shipping option during checkout, when a shipping method is created @@ -445,8 +427,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { `","optional":false,"defaultValue":"","description":"","expandable":false,"children":[]}]}]} /> -___ - ### validateOption Once the admin creates the shipping option, the data of the shipping option will be validated first using this method. This method is called when the [Create Shipping Option API Route](https://docs.medusajs.com/api/admin#shipping-options\_postshippingoptions) is used. @@ -474,8 +454,6 @@ class MyFulfillmentService extends AbstractFulfillmentService { -___ - ### withTransaction #### Parameters diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.adjustInventory.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.adjustInventory.mdx index ee8eb28350..7c80176141 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.adjustInventory.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.adjustInventory.mdx @@ -42,4 +42,4 @@ async function adjustInventory ( ## Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"the reserved stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"the total stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} /> +` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"the reserved stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"the total stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} /> diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createInventoryItem.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createInventoryItem.mdx index c4e4be69a3..5c4f7bb3f7 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createInventoryItem.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createInventoryItem.mdx @@ -39,4 +39,4 @@ async function createInventoryItem (item: { ## Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} /> +` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} /> diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createInventoryLevel.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createInventoryLevel.mdx index 887c861349..1f8e243cda 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createInventoryLevel.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createInventoryLevel.mdx @@ -40,4 +40,4 @@ async function createInventoryLevel (item: { ## Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"the reserved stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"the total stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} /> +` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"the reserved stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"the total stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} /> diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createReservationItem.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createReservationItem.mdx index 53ef28cbd7..1954136d6f 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createReservationItem.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.createReservationItem.mdx @@ -40,4 +40,4 @@ async function createReservationItem (item: { ## Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} /> +` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} /> diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryItem.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryItem.mdx index c5c22bfabc..754dac91ce 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryItem.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryItem.mdx @@ -54,4 +54,4 @@ async function retrieveInventoryItem (id: string) { ## Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} /> +` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} /> diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryLevel.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryLevel.mdx index 4784f59aa8..5dc0e9e757 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryLevel.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveInventoryLevel.mdx @@ -40,4 +40,4 @@ async function retrieveInventoryLevel ( ## Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"the reserved stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"the total stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} /> +` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"the reserved stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"the total stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} /> diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveReservationItem.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveReservationItem.mdx index 28e8882519..1ab101e7ef 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveReservationItem.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.retrieveReservationItem.mdx @@ -34,4 +34,4 @@ async function retrieveReservationItem (id: string) { ## Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} /> +` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} /> diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateInventoryItem.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateInventoryItem.mdx index 00945cc035..1663ac50b7 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateInventoryItem.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateInventoryItem.mdx @@ -42,4 +42,4 @@ async function updateInventoryItem ( ## Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} /> +` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} /> diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevel.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevel.mdx index cf61995ea7..9dc52ded5e 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevel.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateInventoryLevel.mdx @@ -44,4 +44,4 @@ async function updateInventoryLevel ( ## Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"the reserved stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"the total stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]} /> +` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"the reserved stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"the total stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} /> diff --git a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateReservationItem.mdx b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateReservationItem.mdx index 74acbaa58c..2e16f2218c 100644 --- a/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateReservationItem.mdx +++ b/www/apps/docs/content/references/inventory/IInventoryService/methods/inventory.IInventoryService.updateReservationItem.mdx @@ -42,4 +42,4 @@ async function updateReservationItem ( ## Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} /> +` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} /> diff --git a/www/apps/docs/content/references/inventory/types/inventory.InventoryItemDTO.mdx b/www/apps/docs/content/references/inventory/types/inventory.InventoryItemDTO.mdx index 80de00d190..2f30a1e328 100644 --- a/www/apps/docs/content/references/inventory/types/inventory.InventoryItemDTO.mdx +++ b/www/apps/docs/content/references/inventory/types/inventory.InventoryItemDTO.mdx @@ -8,6 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" **InventoryItemDTO**: `Object` -## Type declaration +## Properties ` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} /> diff --git a/www/apps/docs/content/references/inventory/types/inventory.InventoryLevelDTO.mdx b/www/apps/docs/content/references/inventory/types/inventory.InventoryLevelDTO.mdx index 70d3d88c7b..e49379d0fd 100644 --- a/www/apps/docs/content/references/inventory/types/inventory.InventoryLevelDTO.mdx +++ b/www/apps/docs/content/references/inventory/types/inventory.InventoryLevelDTO.mdx @@ -8,6 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" **InventoryLevelDTO**: `Object` -## Type declaration +## Properties ` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"the reserved stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"the total stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} /> diff --git a/www/apps/docs/content/references/inventory/types/inventory.JoinerRelationship.mdx b/www/apps/docs/content/references/inventory/types/inventory.JoinerRelationship.mdx index 1c5e18d2ba..f52ffb4fb6 100644 --- a/www/apps/docs/content/references/inventory/types/inventory.JoinerRelationship.mdx +++ b/www/apps/docs/content/references/inventory/types/inventory.JoinerRelationship.mdx @@ -8,6 +8,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" **JoinerRelationship**: `Object` -## Type declaration +## Properties `","description":"Extra arguments to pass to the remoteFetchData callback","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverse","type":"`boolean`","description":"In an inverted relationship the foreign key is on the other service and the primary key is on the current service","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isInternalService","type":"`boolean`","description":"If true, the relationship is an internal service from the medusa core\nTODO: Remove when there are no more \"internal\" services","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"isList","type":"`boolean`","description":"Force the relationship to return a list","optional":true,"defaultValue":"","expandable":false,"children":[]}]} /> diff --git a/www/apps/docs/content/references/inventory/types/inventory.ReservationItemDTO.mdx b/www/apps/docs/content/references/inventory/types/inventory.ReservationItemDTO.mdx index 505d6ee34e..112b26b4c2 100644 --- a/www/apps/docs/content/references/inventory/types/inventory.ReservationItemDTO.mdx +++ b/www/apps/docs/content/references/inventory/types/inventory.ReservationItemDTO.mdx @@ -10,6 +10,6 @@ import ParameterTypes from "@site/src/components/ParameterTypes" Represents a reservation of an inventory item at a stock location -## Type declaration +## Properties ` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The id of the reservation item","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string` \\| `null`","description":"UserId of user who created the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string` \\| `null`","description":"Description of the reservation item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"line_item_id","type":"`string` \\| `null`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]} /> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AddressesResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AddressesResource.mdx index 47bd699634..54f78c9510 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AddressesResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AddressesResource.mdx @@ -44,13 +44,11 @@ medusa.customers.addresses.addAddress({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### deleteAddress @@ -74,9 +72,7 @@ medusa.customers.addresses.deleteAddress(addressId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### updateAddress @@ -98,8 +94,8 @@ medusa.customers.addresses.updateAddress(addressId, { #### Parameters -`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"Phone Number","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"Postal Code","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"Province","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`string`","description":"Company","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_1","type":"`string`","description":"Address line 1","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`string`","description":"Address line 2","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`string`","description":"City","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"country_code","type":"`string`","description":"The 2 character ISO code of the country in lower case","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`string`","description":"Province","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`string`","description":"Postal Code","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminAuthResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminAuthResource.mdx index 6d7ba915c0..4a332e57f0 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminAuthResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminAuthResource.mdx @@ -43,9 +43,7 @@ medusa.admin.AdminAuthResource.createSession({ #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### deleteSession @@ -69,8 +67,6 @@ medusa.admin.auth.deleteSession() -___ - ### getSession Get the currently logged in user's details. Can also be used to check if there is an authenticated user. @@ -93,9 +89,7 @@ medusa.admin.auth.getSession() #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### getToken @@ -121,4 +115,4 @@ medusa.admin.auth.getToken({ #### Returns - + diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminBatchJobsResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminBatchJobsResource.mdx index 9ef1af810b..e536dfa659 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminBatchJobsResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminBatchJobsResource.mdx @@ -41,9 +41,7 @@ medusa.admin.batchJobs.cancel(batchJobId) #### Returns -`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROCESSING","type":"`\"processing\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date of the concellation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date of the completion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date when the confirmation has been done.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`Date`","description":"The date when the job failed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`Date`","description":"The date from which the job has been pre-processed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"processing_at","type":"`Date`","description":"The date the job is processing at.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROCESSING","type":"`\"processing\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date of the concellation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date of the completion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date when the confirmation has been done.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`Date`","description":"The date when the job failed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`Date`","description":"The date from which the job has been pre-processed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"processing_at","type":"`Date`","description":"The date the job is processing at.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### confirm @@ -67,9 +65,7 @@ medusa.admin.batchJobs.confirm(batchJobId) #### Returns -`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROCESSING","type":"`\"processing\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date of the concellation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date of the completion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date when the confirmation has been done.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`Date`","description":"The date when the job failed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`Date`","description":"The date from which the job has been pre-processed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"processing_at","type":"`Date`","description":"The date the job is processing at.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROCESSING","type":"`\"processing\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date of the concellation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date of the completion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date when the confirmation has been done.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`Date`","description":"The date when the job failed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`Date`","description":"The date from which the job has been pre-processed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"processing_at","type":"`Date`","description":"The date the job is processing at.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### create @@ -93,13 +89,11 @@ medusa.admin.batchJobs.create({ #### Parameters -`","description":"Additional infomration regarding the batch to be used for processing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Set a batch job in dry\\_run mode, which would delay executing the batch job until it's confirmed.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"The type of batch job to start, which is defined by the `batchType` property of the associated batch job strategy.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Additional infomration regarding the batch to be used for processing.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Set a batch job in dry\\_run mode, which would delay executing the batch job until it's confirmed.","optional":false,"defaultValue":"false","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROCESSING","type":"`\"processing\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date of the concellation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date of the completion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date when the confirmation has been done.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`Date`","description":"The date when the job failed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`Date`","description":"The date from which the job has been pre-processed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"processing_at","type":"`Date`","description":"The date the job is processing at.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROCESSING","type":"`\"processing\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date of the concellation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date of the completion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date when the confirmation has been done.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`Date`","description":"The date when the job failed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`Date`","description":"The date from which the job has been pre-processed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"processing_at","type":"`Date`","description":"The date the job is processing at.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### list @@ -151,13 +145,11 @@ medusa.admin.batchJobs.list({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetBatchParams](../../medusa/classes/medusa.AdminGetBatchParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved batch jobs.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"10","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| [DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `canceled_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`null` \\| [DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `completed_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| [DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `confirmed_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`null` \\| [DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `failed_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"IDs to filter batch jobs by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`null` \\| [DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `pre_processed_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`[]","description":"Types to filter batch jobs by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetBatchParams](../../medusa/classes/medusa.AdminGetBatchParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved batch jobs.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"10","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"IDs to filter batch jobs by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`[]","description":"Types to filter batch jobs by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`null` \\| [DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `confirmed_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`null` \\| [DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `pre_processed_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`null` \\| [DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `completed_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`null` \\| [DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `failed_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`null` \\| [DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `canceled_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the batch jobs' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROCESSING","type":"`\"processing\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date of the concellation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date of the completion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date when the confirmation has been done.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`Date`","description":"The date when the job failed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`Date`","description":"The date from which the job has been pre-processed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"processing_at","type":"`Date`","description":"The date the job is processing at.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROCESSING","type":"`\"processing\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date of the concellation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date of the completion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date when the confirmation has been done.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`Date`","description":"The date when the job failed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`Date`","description":"The date from which the job has been pre-processed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"processing_at","type":"`Date`","description":"The date the job is processing at.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### retrieve @@ -181,4 +173,4 @@ medusa.admin.batchJobs.retrieve(batchJobId) #### Returns -`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROCESSING","type":"`\"processing\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date of the concellation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date of the completion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date when the confirmation has been done.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`Date`","description":"The date when the job failed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`Date`","description":"The date from which the job has been pre-processed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"processing_at","type":"`Date`","description":"The date the job is processing at.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"The context of the batch job, the type of the batch job determines what the context should contain.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`null` \\| `string`","description":"The unique identifier of the user that created the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by_user","type":"[User](../../entities/classes/entities.User.mdx)","description":"The details of the user that created the batch job.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"api_token","type":"`string`","description":"An API token associated with the user.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The first name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The user's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The last name of the User","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"dry_run","type":"`boolean`","description":"Specify if the job must apply the modifications or not.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The unique identifier for the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"result","type":"`object` & `Record`","description":"The result of the batch job.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"advancement_count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"count","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"errors","type":"(`string` \\| [BatchJobResultError](../../medusa/types/medusa.BatchJobResultError.mdx))[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_key","type":"`string`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"file_size","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"progress","type":"`number`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"stat_descriptors","type":"[BatchJobResultStatDescriptor](../../medusa/types/medusa.BatchJobResultStatDescriptor.mdx)[]","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"[BatchJobStatus](../../medusa/enums/medusa.BatchJobStatus.mdx)","description":"The status of the batch job.","optional":false,"defaultValue":"created","expandable":false,"children":[{"name":"CREATED","type":"`\"created\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRE_PROCESSED","type":"`\"pre_processed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROCESSING","type":"`\"processing\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FAILED","type":"`\"failed\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"`string`","description":"The type of batch job.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was last updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date of the concellation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date of the completion.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date when the confirmation has been done.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"failed_at","type":"`Date`","description":"The date when the job failed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pre_processed_at","type":"`Date`","description":"The date from which the job has been pre-processed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"processing_at","type":"`Date`","description":"The date the job is processing at.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminCollectionsResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminCollectionsResource.mdx index 2633c621be..add6a6091b 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminCollectionsResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminCollectionsResource.mdx @@ -43,9 +43,7 @@ medusa.admin.collections.addProducts(collectionId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](../../entities/classes/entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](../../entities/classes/entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profiles","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The details of the sales channels this product is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"The details of the product tags used in this product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)","description":"The details of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](../../entities/classes/entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](../../entities/classes/entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profiles","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The details of the sales channels this product is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"The details of the product tags used in this product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)","description":"The details of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### create @@ -71,9 +69,7 @@ medusa.admin.collections.create({ #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](../../entities/classes/entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](../../entities/classes/entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profiles","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The details of the sales channels this product is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"The details of the product tags used in this product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)","description":"The details of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](../../entities/classes/entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](../../entities/classes/entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profiles","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The details of the sales channels this product is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"The details of the product tags used in this product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)","description":"The details of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### delete @@ -97,9 +93,7 @@ medusa.admin.collections.delete(collectionId) #### Returns - - -___ + ### list @@ -136,13 +130,11 @@ medusa.admin.collections.list({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetCollectionsParams](../../medusa/classes/medusa.AdminGetCollectionsParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved product collections.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"10","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product collections' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product collections' `deleted_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_condition_id","type":"`string`","description":"Filter product collections by their associated discount condition's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"Handle to filter product collections by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Term to search product collections by their title and handle.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Title to filter product collections by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product collections' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetCollectionsParams](../../medusa/classes/medusa.AdminGetCollectionsParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved product collections.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"10","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Title to filter product collections by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"Handle to filter product collections by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product collections' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product collections' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the product collections' `deleted_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"q","type":"`string`","description":"Term to search product collections by their title and handle.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_condition_id","type":"`string`","description":"Filter product collections by their associated discount condition's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](../../entities/classes/entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](../../entities/classes/entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profiles","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The details of the sales channels this product is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"The details of the product tags used in this product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)","description":"The details of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](../../entities/classes/entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](../../entities/classes/entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profiles","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The details of the sales channels this product is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"The details of the product tags used in this product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)","description":"The details of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### removeProducts @@ -171,9 +163,7 @@ medusa.admin.collections.removeProducts(collectionId, { #### Returns - - -___ + ### retrieve @@ -197,9 +187,7 @@ medusa.admin.collections.retrieve(collectionId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](../../entities/classes/entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](../../entities/classes/entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profiles","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The details of the sales channels this product is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"The details of the product tags used in this product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)","description":"The details of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](../../entities/classes/entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](../../entities/classes/entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profiles","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The details of the sales channels this product is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"The details of the product tags used in this product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)","description":"The details of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### update @@ -221,8 +209,8 @@ medusa.admin.collections.update(collectionId, { #### Parameters -`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the collection.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](../../entities/classes/entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](../../entities/classes/entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profiles","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The details of the sales channels this product is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"The details of the product tags used in this product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)","description":"The details of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](../../entities/classes/entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](../../entities/classes/entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profiles","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The details of the sales channels this product is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"The details of the product tags used in this product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)","description":"The details of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminCurrenciesResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminCurrenciesResource.mdx index 04d56434d3..ed67269518 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminCurrenciesResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminCurrenciesResource.mdx @@ -54,13 +54,11 @@ medusa.admin.currencies.list({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetCurrenciesParams](../../medusa/classes/medusa.AdminGetCurrenciesParams.mdx)","description":"Filters and pagination configurations to apply on retrieved currencies.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"Code to filter currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Filter currencies by whether they include tax.","optional":true,"defaultValue":"","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.\nBy default, the returned currencies will be sorted by their `created_at` field.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetCurrenciesParams](../../medusa/classes/medusa.AdminGetCurrenciesParams.mdx)","description":"Filters and pagination configurations to apply on retrieved currencies.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"Code to filter currencies by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Filter currencies by whether they include tax.","optional":true,"defaultValue":"","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.\nBy default, the returned currencies will be sorted by their `created_at` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns - - -___ + ### update @@ -86,4 +84,4 @@ medusa.admin.currencies.update(code, { #### Returns - + diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminCustomResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminCustomResource.mdx index 4b45b97b9c..24fa09486a 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminCustomResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminCustomResource.mdx @@ -42,8 +42,6 @@ medusa.admin.custom.delete( -___ - ### get Send a `GET` request to a custom API Route. The method accepts a tuple of type parameters: the first `TQuery` is the type of accepted query parameters, @@ -78,8 +76,6 @@ medusa.admin.custom.get, PostsResponse>( -___ - ### post Send a `POST` request to a custom API Route. The method accepts a tuple of type parameters: the first `TPayload` is the type of accepted body parameters, diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminCustomerGroupsResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminCustomerGroupsResource.mdx index daef1c5ae3..88e3f79c0b 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminCustomerGroupsResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminCustomerGroupsResource.mdx @@ -29,9 +29,7 @@ Add a list of customers to a customer group. #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### create @@ -57,9 +55,7 @@ medusa.admin.customerGroups.create({ #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### delete @@ -83,9 +79,7 @@ medusa.admin.customerGroups.delete(customerGroupId) #### Returns - - -___ + ### list @@ -137,13 +131,11 @@ medusa.admin.customerGroups.list({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetCustomerGroupsParams](../../medusa/classes/medusa.AdminGetCustomerGroupsParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved customer groups.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the customer groups' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_condition_id","type":"`string`","description":"Filter customer groups by their associated discount condition's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"IDs to filter customer groups by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"10","expandable":false,"children":[]},{"name":"name","type":"`string`[]","description":"Names to filter customer groups by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search customer groups by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the customer groups' `update_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetCustomerGroupsParams](../../medusa/classes/medusa.AdminGetCustomerGroupsParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved customer groups.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"10","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"IDs to filter customer groups by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search customer groups by their name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`[]","description":"Names to filter customer groups by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the customer groups' `update_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the customer groups' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_condition_id","type":"`string`","description":"Filter customer groups by their associated discount condition's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### listCustomers @@ -163,13 +155,11 @@ medusa.admin.customerGroups.listCustomers(customerGroupId) #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetCustomersParams](../../medusa/classes/medusa.AdminGetCustomersParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved customers.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"50","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`string`[]","description":"Filter customers by the customer's customer groups.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"Filter customers by whether they have an account.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term used to search customers' email, first name, last name.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetCustomersParams](../../medusa/classes/medusa.AdminGetCustomersParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved customers.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"50","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term used to search customers' email, first name, last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"Filter customers by whether they have an account.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`string`[]","description":"Filter customers by the customer's customer groups.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### removeCustomers @@ -199,9 +189,7 @@ medusa.admin.customerGroups.removeCustomers(customerGroupId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### retrieve @@ -225,9 +213,7 @@ medusa.admin.customerGroups.retrieve(customerGroupId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### update @@ -235,8 +221,8 @@ Update a customer group's details. #### Parameters -`","description":"Metadata of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"Name of the customer group","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Metadata of the customer group.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The details of the customer groups that the Price List can apply to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminCustomersResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminCustomersResource.mdx index e911d156fd..62c163818b 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminCustomersResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminCustomersResource.mdx @@ -41,13 +41,11 @@ medusa.admin.customers.create({ #### Parameters -`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### list @@ -99,13 +97,11 @@ medusa.admin.customers.list({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetCustomersParams](../../medusa/classes/medusa.AdminGetCustomersParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved customers.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"50","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`string`[]","description":"Filter customers by the customer's customer groups.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"Filter customers by whether they have an account.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term used to search customers' email, first name, last name.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetCustomersParams](../../medusa/classes/medusa.AdminGetCustomersParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved customers.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"50","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term used to search customers' email, first name, last name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"has_account","type":"`boolean`","description":"Filter customers by whether they have an account.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"`string`[]","description":"Filter customers by the customer's customer groups.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### retrieve @@ -129,9 +125,7 @@ medusa.admin.customers.retrieve(customerId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### update @@ -153,8 +147,8 @@ medusa.admin.customers.update(customerId, { #### Parameters -`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"password","type":"`string`","description":"The Customer's password.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The Customer's phone number.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[Group](../../medusa/classes/medusa.Group.mdx)[]","description":"A list of customer groups to which the customer belongs.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The ID of a customer group","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customers","type":"[Customer](../../entities/classes/entities.Customer.mdx)[]","description":"The details of the customers that belong to the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer group's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminDiscountsResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminDiscountsResource.mdx index 50c0718a20..35b2e0c19d 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminDiscountsResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminDiscountsResource.mdx @@ -62,9 +62,7 @@ medusa.admin.discounts.addConditionResourceBatch(discountId, conditionId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### addRegion @@ -88,9 +86,7 @@ medusa.admin.discounts.addRegion(discountId, regionId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### create @@ -121,13 +117,11 @@ medusa.admin.discounts.create({ #### Parameters -`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The date and time at which the discount should be available.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_limit","type":"`number`","description":"Maximum number of times the discount can be used","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`string`","description":"The duration the discount runs between","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### createCondition @@ -172,13 +166,11 @@ medusa.admin.discounts.createCondition(discountId, { #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### createDynamicCode @@ -205,9 +197,7 @@ medusa.admin.discounts.createDynamicCode(discountId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### delete @@ -231,9 +221,7 @@ medusa.admin.discounts.delete(discountId) #### Returns - - -___ + ### deleteCondition @@ -257,9 +245,7 @@ medusa.admin.discounts.deleteCondition(discountId, conditionId) #### Returns - - -___ + ### deleteConditionResourceBatch @@ -285,9 +271,7 @@ medusa.admin.discounts.deleteConditionResourceBatch(discountId, conditionId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### deleteDynamicCode @@ -311,9 +295,7 @@ medusa.admin.discounts.deleteDynamicCode(discountId, code) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### getCondition @@ -353,9 +335,7 @@ medusa.admin.discounts.getCondition(discountId, conditionId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../../entities/enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"IN","type":"`\"in\"`","description":"The discountable resources are within the specified resources.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_IN","type":"`\"not_in\"`","description":"The discountable resources are everything but the specified resources.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_collections","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"A unique string that identifies the Product Collection - can for example be used in slug structures.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product tag's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Tag represents","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_types","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product type's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Type represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](../../entities/classes/entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](../../entities/classes/entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profiles","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The details of the sales channels this product is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"The details of the product tags used in this product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)","description":"The details of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[DiscountConditionType](../../entities/enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CUSTOMER_GROUPS","type":"`\"customer_groups\"`","description":"The discount condition is used for customer groups.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTS","type":"`\"products\"`","description":"The discount condition is used for products.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCT_COLLECTIONS","type":"`\"product_collections\"`","description":"The discount condition is used for product collections.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCT_TAGS","type":"`\"product_tags\"`","description":"The discount condition is used for product tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCT_TYPES","type":"`\"product_types\"`","description":"The discount condition is used for product types.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule associated with the condition.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"discount_rule_id","type":"`string`","description":"The ID of the discount rule associated with the condition","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount condition's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"operator","type":"[DiscountConditionOperator](../../entities/enums/entities.DiscountConditionOperator.mdx)","description":"The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not\\_in` indicates that discountable resources are everything but the specified resources.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"IN","type":"`\"in\"`","description":"The discountable resources are within the specified resources.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_IN","type":"`\"not_in\"`","description":"The discountable resources are everything but the specified resources.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_collections","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)[]","description":"Product collections associated with this condition if `type` is `product\\_collections`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"A unique string that identifies the Product Collection - can for example be used in slug structures.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"The details of the products that belong to this product collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"title","type":"`string`","description":"The title that the Product Collection is identified by.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"Product tags associated with this condition if `type` is `product\\_tags`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product tag's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Tag represents","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"product_types","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)[]","description":"Product types associated with this condition if `type` is `product\\_types`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product type's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The value that the Product Type represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"products associated with this condition if `type` is `products`.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"categories","type":"[ProductCategory](../../entities/classes/entities.ProductCategory.mdx)[]","description":"The details of the product categories that this product belongs to.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"product_categories","children":[]},{"name":"collection","type":"[ProductCollection](../../entities/classes/entities.ProductCollection.mdx)","description":"The details of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"collection_id","type":"`null` \\| `string`","description":"The ID of the product collection that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A short description of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discountable","type":"`boolean`","description":"Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The external ID of the product","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`null` \\| `string`","description":"A unique identifier for the Product (e.g. for slug structure).","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"images","type":"[Image](../../entities/classes/entities.Image.mdx)[]","description":"The details of the product's images.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOption](../../entities/classes/entities.ProductOption.mdx)[]","description":"The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profile","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)","description":"The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"profile_id","type":"`string`","description":"The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"profiles","type":"[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]","description":"Available if the relation `profiles` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The details of the sales channels this product is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)","description":"The status of the product","optional":false,"defaultValue":"draft","expandable":false,"children":[]},{"name":"subtitle","type":"`null` \\| `string`","description":"An optional subtitle that can be used to further specify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"[ProductTag](../../entities/classes/entities.ProductTag.mdx)[]","description":"The details of the product tags used in this product.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL to an image file that can be used to identify the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ProductType](../../entities/classes/entities.ProductType.mdx)","description":"The details of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type_id","type":"`null` \\| `string`","description":"The ID of the product type that the product belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[DiscountConditionType](../../entities/enums/entities.DiscountConditionType.mdx)","description":"The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CUSTOMER_GROUPS","type":"`\"customer_groups\"`","description":"The discount condition is used for customer groups.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCTS","type":"`\"products\"`","description":"The discount condition is used for products.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCT_COLLECTIONS","type":"`\"product_collections\"`","description":"The discount condition is used for product collections.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCT_TAGS","type":"`\"product_tags\"`","description":"The discount condition is used for product tags.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PRODUCT_TYPES","type":"`\"product_types\"`","description":"The discount condition is used for product types.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### list @@ -407,13 +387,11 @@ medusa.admin.discounts.list({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetDiscountsParams](../../medusa/classes/medusa.AdminGetDiscountsParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved discounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Filter discounts by whether they're disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"Filter discounts by whether they're dynamic.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search terms to search discounts' code fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule","type":"[AdminGetDiscountsDiscountRuleParams](../../medusa/classes/medusa.AdminGetDiscountsDiscountRuleParams.mdx)","description":"Filter discounts by their associated rule.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"Allocation to filter discount rules by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ITEM","type":"`\"item\"`","description":"The discount should be applied to applicable items in the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"TOTAL","type":"`\"total\"`","description":"The discount should be applied to the checkout total.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"Type to filter discount rules by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"FIXED","type":"`\"fixed\"`","description":"Discounts that reduce the price by a fixed amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FREE_SHIPPING","type":"`\"free_shipping\"`","description":"Discounts that sets the shipping price to `0`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PERCENTAGE","type":"`\"percentage\"`","description":"Discounts that reduce the price by a percentage reduction.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetDiscountsParams](../../medusa/classes/medusa.AdminGetDiscountsParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved discounts.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"rule","type":"[AdminGetDiscountsDiscountRuleParams](../../medusa/classes/medusa.AdminGetDiscountsDiscountRuleParams.mdx)","description":"Filter discounts by their associated rule.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"Type to filter discount rules by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"FIXED","type":"`\"fixed\"`","description":"Discounts that reduce the price by a fixed amount.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FREE_SHIPPING","type":"`\"free_shipping\"`","description":"Discounts that sets the shipping price to `0`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PERCENTAGE","type":"`\"percentage\"`","description":"Discounts that reduce the price by a percentage reduction.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"Allocation to filter discount rules by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ITEM","type":"`\"item\"`","description":"The discount should be applied to applicable items in the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"TOTAL","type":"`\"total\"`","description":"The discount should be applied to the checkout total.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"q","type":"`string`","description":"Search terms to search discounts' code fields.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"Filter discounts by whether they're dynamic.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Filter discounts by whether they're disabled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### removeRegion @@ -437,9 +415,7 @@ medusa.admin.discounts.removeRegion(discountId, regionId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### retrieve @@ -463,9 +439,7 @@ medusa.admin.discounts.retrieve(discountId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### retrieveByCode @@ -489,9 +463,7 @@ medusa.admin.discounts.retrieveByCode(code) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### update @@ -513,13 +485,11 @@ medusa.admin.discounts.update(discountId, { #### Parameters -`","description":"An object containing metadata of the discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"`string`[]","description":"A list of region IDs representing the Regions in which the Discount can be used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rule","type":"[AdminUpdateDiscountRule](../../medusa/classes/medusa.AdminUpdateDiscountRule.mdx)","description":"The discount rule that defines how discounts are calculated","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"The discount rule's ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The discount rule's allocation.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ITEM","type":"`\"item\"`","description":"The discount should be applied to applicable items in the cart.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"TOTAL","type":"`\"total\"`","description":"The discount should be applied to the checkout total.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"conditions","type":"[AdminUpsertCondition](../../medusa/classes/medusa.AdminUpsertCondition.mdx)[]","description":"The discount rule's discount conditions.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"operator","type":"[DiscountConditionOperator](../../entities/enums/entities.DiscountConditionOperator.mdx)","description":"The discount condition's operator.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"`string`[]","description":"The customer groups associated with the discount condition, if the discount condition's type is `customer_groups`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount condition's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_collections","type":"`string`[]","description":"The product collections associated with the discount condition, if the discount condition's type is `product_collections`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_tags","type":"`string`[]","description":"The product tags associated with the discount condition, if the discount condition's type is `product_tags`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"product_types","type":"`string`[]","description":"The product types associated with the discount condition, if the discount condition's type is `product_types`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"products","type":"`string`[]","description":"The products associated with the discount condition, if the discount condition's type is `products`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"The discount rule's description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The discount rule's value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"starts_at","type":"`Date`","description":"The date and time at which the discount should be available.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"Maximum number of times the discount can be used","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"The duration the discount runs between","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An object containing metadata of the discount","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### updateCondition @@ -564,8 +534,8 @@ medusa.admin.discounts.updateCondition(discountId, conditionId, { #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"allocation","type":"[AllocationType](../../entities/enums/entities.AllocationType.mdx)","description":"The scope that the discount should apply to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"conditions","type":"[DiscountCondition](../../entities/classes/entities.DiscountCondition.mdx)[]","description":"The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"A short description of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount rule's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[DiscountRuleType](../../entities/enums/entities.DiscountRuleType.mdx)","description":"The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free\\_shipping` for shipping vouchers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the discount represents; this will depend on the type of the discount","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminDraftOrdersResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminDraftOrdersResource.mdx index 3a50e656fa..ce06d6a32e 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminDraftOrdersResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminDraftOrdersResource.mdx @@ -38,13 +38,11 @@ medusa.admin.draftOrders.addLineItem(draftOrderId, { #### Parameters -`","description":"The optional key-value map with additional details about the Line Item.","optional":true,"defaultValue":"{}","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item if `variant\\_id` is not provided.","optional":true,"defaultValue":"\"Custom item\"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The custom price of the line item. If a `variant\\_id` is supplied, the price provided here will override the variant's price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the Product Variant associated with the line item. If the line item is custom, the `variant\\_id` should be omitted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"The optional key-value map with additional details about the Line Item.","optional":true,"defaultValue":"{}","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### create @@ -77,13 +75,11 @@ medusa.admin.draftOrders.create({ #### Parameters -`","description":"The optional additional data needed for the shipping method","optional":true,"defaultValue":"{}","expandable":false,"children":[]},{"name":"price","type":"`number`","description":"The price of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address","type":"`string` \\| [AddressPayload](../../medusa/classes/medusa.AddressPayload.mdx)","description":"The Address to be used for billing purposes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer this draft order is associated with.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../medusa/classes/medusa.Discount.mdx)[]","description":"The discounts to add to the draft order","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the discount to apply","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"items","type":"[Item](../../medusa/classes/medusa.Item-1.mdx)[]","description":"The draft order's line items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"The optional key-value map with additional details about the line item.","optional":true,"defaultValue":"{}","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item if `variant\\_id` is not provided.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The custom price of the line item. If a `variant\\_id` is supplied, the price provided here will override the variant's price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the Product Variant associated with the line item. If the line item is custom, the `variant\\_id` should be omitted.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"The optional key-value map with additional details about the Draft Order.","optional":true,"defaultValue":"{}","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"An optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`string` \\| [AddressPayload](../../medusa/classes/medusa.AddressPayload.mdx)","description":"The Address to be used for shipping purposes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"The status of the draft order. The draft order's default status is `open`. It's changed to `completed` when its payment is marked as paid.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"The optional additional data needed for the shipping method","optional":true,"defaultValue":"{}","expandable":false,"children":[]},{"name":"price","type":"`number`","description":"The price of the shipping method.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"status","type":"`string`","description":"The status of the draft order. The draft order's default status is `open`. It's changed to `completed` when its payment is marked as paid.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"billing_address","type":"`string` \\| [AddressPayload](../../medusa/classes/medusa.AddressPayload.mdx)","description":"The Address to be used for billing purposes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`string` \\| [AddressPayload](../../medusa/classes/medusa.AddressPayload.mdx)","description":"The Address to be used for shipping purposes.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[Item](../../medusa/classes/medusa.Item.mdx)[]","description":"The draft order's line items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item if `variant\\_id` is not provided.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The custom price of the line item. If a `variant\\_id` is supplied, the price provided here will override the variant's price.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the Product Variant associated with the line item. If the line item is custom, the `variant\\_id` should be omitted.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"The optional key-value map with additional details about the line item.","optional":true,"defaultValue":"{}","expandable":false,"children":[]}]},{"name":"discounts","type":"[Discount](../../medusa/classes/medusa.Discount.mdx)[]","description":"The discounts to add to the draft order","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"code","type":"`string`","description":"The code of the discount to apply","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_id","type":"`string`","description":"The ID of the customer this draft order is associated with.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"An optional flag passed to the resulting order that indicates whether the customer should receive notifications about order updates.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"The optional key-value map with additional details about the Draft Order.","optional":true,"defaultValue":"{}","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### delete @@ -107,9 +103,7 @@ medusa.admin.draftOrders.delete(draftOrderId) #### Returns - - -___ + ### list @@ -146,13 +140,11 @@ medusa.admin.draftOrders.list({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetDraftOrdersParams](../../medusa/classes/medusa.AdminGetDraftOrdersParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved draft orders.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"50","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search draft orders by their display IDs and emails.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetDraftOrdersParams](../../medusa/classes/medusa.AdminGetDraftOrdersParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved draft orders.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search term to search draft orders by their display IDs and emails.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"50","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### markPaid @@ -177,9 +169,7 @@ medusa.admin.draftOrders.markPaid(draftOrderId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The billing address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date with timezone at which the cart was completed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"additional_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the new items to be shipped when the claim's type is `replace`","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the claim was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)[]","description":"The details of the items that should be replaced or refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[ClaimFulfillmentStatus](../../entities/enums/entities.ClaimFulfillmentStatus.mdx)","description":"The claim's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The fulfillments of the new items to be shipped","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The claim's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this claim was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the claim comes from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[ClaimPaymentStatus](../../entities/enums/entities.ClaimPaymentStatus.mdx)","description":"The status of the claim's payment","optional":false,"defaultValue":"na","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount that will be refunded in conjunction with the claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](../../entities/classes/entities.Return.mdx)","description":"The details of the return associated with the claim if the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the address that new items should be shipped to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the address that the new items should be shipped to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods that the claim order will be shipped with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[ClaimType](../../entities/enums/entities.ClaimType.mdx)","description":"The claim's type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"canceled_at","type":"`Date`","description":"The date the draft order was canceled at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"changes","type":"[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)[]","description":"The details of all the changes on the original order's line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The unique identifier of the user or customer who created the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference between the total amount of the order and total amount of edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of the gift card tax amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of the gift card amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order edit's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order's fulfillments are canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLED","type":"`\"fulfilled\"`","description":"The order's items are fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_FULFILLED","type":"`\"not_fulfilled\"`","description":"The order's items are not fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_FULFILLED","type":"`\"partially_fulfilled\"`","description":"Some of the order's items, but not all, are fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_RETURNED","type":"`\"partially_returned\"`","description":"Some of the order's items, but not all, are returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_SHIPPED","type":"`\"partially_shipped\"`","description":"Some of the order's items, but not all, are shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order's fulfillment requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"RETURNED","type":"`\"returned\"`","description":"The order's items are returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPED","type":"`\"shipped\"`","description":"The order's items are shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)","description":"The details of the claim that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the Claim that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"This contains all the data necessary for the Fulfillment provider to handle the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The fulfillment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the fulfillment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItem](../../entities/classes/entities.FulfillmentItem.mdx)[]","description":"The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"location_id","type":"`null` \\| `string`","description":"The ID of the stock location the fulfillment will be shipped from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be sent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the Order that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the Fulfillment Provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`Date`","description":"The date with timezone at which the Fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the Swap that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_links","type":"[TrackingLink](../../entities/classes/entities.TrackingLink.mdx)[]","description":"The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tracking_numbers","type":"`string`[]","description":"The tracking numbers that can be used to track the status of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that was used from the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)","description":"The details of the gift card associated used in this transaction.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_id","type":"`string`","description":"The ID of the Gift Card that was used in the transaction.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The gift card transaction's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_taxable","type":"`boolean`","description":"Whether the transaction is taxable or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the gift card was used for payment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was used for payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The tax rate of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"balance","type":"`number`","description":"The remaining value on the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The time at which the Gift Card can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The gift card's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The gift card's tax rate that will be applied on calculating totals","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"adjustments","type":"[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]","description":"The details of the item's adjustments, which are available when a discount is applied on the item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_discounts","type":"`boolean`","description":"Flag to indicate if the Line Item should be included when doing discount calculations.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)","description":"The details of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A more detailed description of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been fulfilled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_shipping","type":"`null` \\| `boolean`","description":"Flag to indicate if the Line Item has fulfillment associated with it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The line item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Indicates if the line item unit\\_price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Flag to indicate if the Line Item is a Gift Card.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_return","type":"`boolean`","description":"Is the item being returned","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[{"name":"AWAITING","type":"`\"awaiting\"`","description":"The order's payment is awaiting capturing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order's payment is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CAPTURED","type":"`\"captured\"`","description":"The order's payment is captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_PAID","type":"`\"not_paid\"`","description":"The order's payment is not paid.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_REFUNDED","type":"`\"partially_refunded\"`","description":"Some of the order's payment amount is refunded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REFUNDED","type":"`\"refunded\"`","description":"The order's payment amount is refunded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order's payment requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount_refunded","type":"`number`","description":"The amount of the original Payment amount that has been refunded back to the Customer.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that has be refunded to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The refund's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the refund in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"An optional note explaining why the amount was refunded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order this refund was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order this refund was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the refund.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID, if available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"`string`","description":"The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"claim_order","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)","description":"The details of the claim that the return may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`null` \\| `string`","description":"The ID of the claim that the return may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The return's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`null` \\| `string`","description":"Randomly generated key used to continue the completion of the return in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[ReturnItem](../../entities/classes/entities.ReturnItem.mdx)[]","description":"The details of the items that the customer is returning.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"location_id","type":"`null` \\| `string`","description":"The ID of the stock location the return will be added back.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"When set to true, no notification will be sent related to this return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the return was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the return was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`Date`","description":"The date with timezone at which the return was received.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount that should be refunded as a result of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_data","type":"`Record`","description":"Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)","description":"The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ReturnStatus](../../entities/enums/entities.ReturnStatus.mdx)","description":"Status of the Return.","optional":false,"defaultValue":"requested","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the return may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`null` \\| `string`","description":"The ID of the swap that the return may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"carts","type":"[Cart](../../entities/classes/entities.Cart.mdx)[]","description":"The associated carts.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The sales channel's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Specify if the sales channel is enabled or disabled.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"locations","type":"[SalesChannelLocation](../../entities/classes/entities.SalesChannelLocation.mdx)[]","description":"The details of the stock locations related to the sales channel.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The associated orders.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"publishableKeys","type":"[PublishableApiKey](../../entities/classes/entities.PublishableApiKey.mdx)[]","description":"The associated publishable API keys.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)","description":"The details of the claim that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`null` \\| `string`","description":"The ID of the claim that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The shipping method's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the shipping method price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"`number`","description":"The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the return that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](../../entities/classes/entities.Return.mdx)","description":"The details of the return that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_option","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)","description":"The details of the shipping option the method was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the Shipping Option that the Shipping Method is built from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx)[]","description":"The details of the tax lines applied on the shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the shipping","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed, meaning that\nthe items have been fulfilled and the payment\nhas been captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"additional_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the new products to send to the customer, represented as line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"If true, swaps can be completed with items out of stock","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Swap was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the Swap was confirmed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[SwapFulfillmentStatus](../../entities/enums/entities.SwapFulfillmentStatus.mdx)","description":"The status of the Fulfillment of the Swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments that are used to send the new items to the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The swap's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the swap in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true, no notification will be sent related to this swap","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the additional payment authorized by the customer when `difference\\_due` is positive.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_status","type":"[SwapPaymentStatus](../../entities/enums/entities.SwapPaymentStatus.mdx)","description":"The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](../../entities/classes/entities.Return.mdx)","description":"The details of the return that belongs to the swap, which holds the details on the items being returned.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address that the new items should be sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used to fulfill the additional items purchased.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"adjustments","type":"[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]","description":"The details of the item's adjustments, which are available when a discount is applied on the item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_discounts","type":"`boolean`","description":"Flag to indicate if the Line Item should be included when doing discount calculations.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)","description":"The details of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A more detailed description of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been fulfilled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_shipping","type":"`null` \\| `boolean`","description":"Flag to indicate if the Line Item has fulfillment associated with it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The line item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Indicates if the line item unit\\_price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Flag to indicate if the Line Item is a Gift Card.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_return","type":"`boolean`","description":"Is the item being returned","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[{"name":"carts","type":"[Cart](../../entities/classes/entities.Cart.mdx)[]","description":"The associated carts.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The sales channel's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Specify if the sales channel is enabled or disabled.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"locations","type":"[SalesChannelLocation](../../entities/classes/entities.SalesChannelLocation.mdx)[]","description":"The details of the stock locations related to the sales channel.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The associated orders.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"publishableKeys","type":"[PublishableApiKey](../../entities/classes/entities.PublishableApiKey.mdx)[]","description":"The associated publishable API keys.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The billing address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date with timezone at which the cart was completed.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"context","type":"`Record`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"additional_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the new items to be shipped when the claim's type is `replace`","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the claim was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_items","type":"[ClaimItem](../../entities/classes/entities.ClaimItem.mdx)[]","description":"The details of the items that should be replaced or refunded.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[ClaimFulfillmentStatus](../../entities/enums/entities.ClaimFulfillmentStatus.mdx)","description":"The claim's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The fulfillments of the new items to be shipped","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The claim's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this claim was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the claim comes from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[ClaimPaymentStatus](../../entities/enums/entities.ClaimPaymentStatus.mdx)","description":"The status of the claim's payment","optional":false,"defaultValue":"na","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount that will be refunded in conjunction with the claim","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](../../entities/classes/entities.Return.mdx)","description":"The details of the return associated with the claim if the claim's type is `replace`.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the address that new items should be shipped to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the address that the new items should be shipped to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods that the claim order will be shipped with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[ClaimType](../../entities/enums/entities.ClaimType.mdx)","description":"The claim's type","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`null` \\| `string`","description":"The customer's billing address ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The customer's email","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`string`","description":"The customer's first name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"groups","type":"[CustomerGroup](../../entities/classes/entities.CustomerGroup.mdx)[]","description":"The customer groups the customer belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"has_account","type":"`boolean`","description":"Whether the customer has an account or not","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`string`","description":"The customer's last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"A unique code for the discount - this will be used by the customer to apply the discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The time at which the discount can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The discount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Discount has been disabled. Disabled discounts cannot be applied to carts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_dynamic","type":"`boolean`","description":"A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_discount","type":"[Discount](../../entities/classes/entities.Discount.mdx)","description":"The details of the parent discount that this discount was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"parent_discount_id","type":"`string`","description":"The Discount that the discount was created from. This will always be a dynamic discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"regions","type":"[Region](../../entities/classes/entities.Region.mdx)[]","description":"The details of the regions in which the Discount can be used.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule","type":"[DiscountRule](../../entities/classes/entities.DiscountRule.mdx)","description":"The details of the discount rule that defines how the discount will be applied to a cart..","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"rule_id","type":"`string`","description":"The ID of the discount rule that defines how the discount will be applied to a cart.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"starts_at","type":"`Date`","description":"The time at which the discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"usage_count","type":"`number`","description":"The number of times a discount has been used.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"usage_limit","type":"`null` \\| `number`","description":"The maximum number of times that a discount can be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"valid_duration","type":"`null` \\| `string`","description":"Duration the discount runs between","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"canceled_at","type":"`Date`","description":"The date the draft order was canceled at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"changes","type":"[OrderItemChange](../../entities/classes/entities.OrderItemChange.mdx)[]","description":"The details of all the changes on the original order's line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The unique identifier of the user or customer who created the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference between the total amount of the order and total amount of edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of the gift card tax amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of the gift card amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The order edit's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order's fulfillments are canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"FULFILLED","type":"`\"fulfilled\"`","description":"The order's items are fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_FULFILLED","type":"`\"not_fulfilled\"`","description":"The order's items are not fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_FULFILLED","type":"`\"partially_fulfilled\"`","description":"Some of the order's items, but not all, are fulfilled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_RETURNED","type":"`\"partially_returned\"`","description":"Some of the order's items, but not all, are returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_SHIPPED","type":"`\"partially_shipped\"`","description":"Some of the order's items, but not all, are shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order's fulfillment requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"RETURNED","type":"`\"returned\"`","description":"The order's items are returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"SHIPPED","type":"`\"shipped\"`","description":"The order's items are shipped.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Fulfillment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)","description":"The details of the claim that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the Claim that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"This contains all the data necessary for the Fulfillment provider to handle the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The fulfillment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the fulfillment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[FulfillmentItem](../../entities/classes/entities.FulfillmentItem.mdx)[]","description":"The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"location_id","type":"`null` \\| `string`","description":"The ID of the stock location the fulfillment will be shipped from","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be sent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the Order that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)","description":"The details of the fulfillment provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the Fulfillment Provider responsible for handling the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_at","type":"`Date`","description":"The date with timezone at which the Fulfillment was shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the fulfillment may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the Swap that the Fulfillment belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tracking_links","type":"[TrackingLink](../../entities/classes/entities.TrackingLink.mdx)[]","description":"The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tracking_numbers","type":"`string`[]","description":"The tracking numbers that can be used to track the status of the fulfillment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that was used from the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)","description":"The details of the gift card associated used in this transaction.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_id","type":"`string`","description":"The ID of the Gift Card that was used in the transaction.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The gift card transaction's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_taxable","type":"`boolean`","description":"Whether the transaction is taxable or not.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the gift card was used for payment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was used for payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The tax rate of the transaction","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"balance","type":"`number`","description":"The remaining value on the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"code","type":"`string`","description":"The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`Date`","description":"The time at which the Gift Card can no longer be used.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The gift card's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The gift card's tax rate that will be applied on calculating totals","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"adjustments","type":"[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]","description":"The details of the item's adjustments, which are available when a discount is applied on the item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_discounts","type":"`boolean`","description":"Flag to indicate if the Line Item should be included when doing discount calculations.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)","description":"The details of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A more detailed description of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been fulfilled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_shipping","type":"`null` \\| `boolean`","description":"Flag to indicate if the Line Item has fulfillment associated with it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The line item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Indicates if the line item unit\\_price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Flag to indicate if the Line Item is a Gift Card.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_return","type":"`boolean`","description":"Is the item being returned","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[{"name":"AWAITING","type":"`\"awaiting\"`","description":"The order's payment is awaiting capturing.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order's payment is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CAPTURED","type":"`\"captured\"`","description":"The order's payment is captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_PAID","type":"`\"not_paid\"`","description":"The order's payment is not paid.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_REFUNDED","type":"`\"partially_refunded\"`","description":"Some of the order's payment amount is refunded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REFUNDED","type":"`\"refunded\"`","description":"The order's payment amount is refunded.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order's payment requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount_refunded","type":"`number`","description":"The amount of the original Payment amount that has been refunded back to the Customer.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that has be refunded to the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The refund's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the refund in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"An optional note explaining why the amount was refunded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order this refund was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order this refund was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the refund.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID, if available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"`string`","description":"The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"claim_order","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)","description":"The details of the claim that the return may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`null` \\| `string`","description":"The ID of the claim that the return may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The return's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`null` \\| `string`","description":"Randomly generated key used to continue the completion of the return in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[ReturnItem](../../entities/classes/entities.ReturnItem.mdx)[]","description":"The details of the items that the customer is returning.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"location_id","type":"`null` \\| `string`","description":"The ID of the stock location the return will be added back.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`null` \\| `boolean`","description":"When set to true, no notification will be sent related to this return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the return was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the return was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"received_at","type":"`Date`","description":"The date with timezone at which the return was received.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount that should be refunded as a result of the return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_data","type":"`Record`","description":"Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)","description":"The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"status","type":"[ReturnStatus](../../entities/enums/entities.ReturnStatus.mdx)","description":"Status of the Return.","optional":false,"defaultValue":"requested","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the return may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`null` \\| `string`","description":"The ID of the swap that the return may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"carts","type":"[Cart](../../entities/classes/entities.Cart.mdx)[]","description":"The associated carts.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The sales channel's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Specify if the sales channel is enabled or disabled.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"locations","type":"[SalesChannelLocation](../../entities/classes/entities.SalesChannelLocation.mdx)[]","description":"The details of the stock locations related to the sales channel.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The associated orders.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"publishableKeys","type":"[PublishableApiKey](../../entities/classes/entities.PublishableApiKey.mdx)[]","description":"The associated publishable API keys.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"address_1","type":"`null` \\| `string`","description":"Address line 1","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"address_2","type":"`null` \\| `string`","description":"Address line 2","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"city","type":"`null` \\| `string`","description":"City","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"company","type":"`null` \\| `string`","description":"Company name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"country","type":"`null` \\| [Country](../../entities/classes/entities.Country.mdx)","description":"A country object.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"country_code","type":"`null` \\| `string`","description":"The 2 character ISO code of the country in lower case","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"`null` \\| [Customer](../../entities/classes/entities.Customer.mdx)","description":"Available if the relation `customer` is expanded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"ID of the customer this address belongs to","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"first_name","type":"`null` \\| `string`","description":"First name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID of the address","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"last_name","type":"`null` \\| `string`","description":"Last name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`null` \\| `string`","description":"Phone Number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"postal_code","type":"`null` \\| `string`","description":"Postal Code","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"province","type":"`null` \\| `string`","description":"Province","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)","description":"The details of the claim that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`null` \\| `string`","description":"The ID of the claim that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The shipping method's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the shipping method price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price","type":"`number`","description":"The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_id","type":"`string`","description":"The ID of the return that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](../../entities/classes/entities.Return.mdx)","description":"The details of the return that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_option","type":"[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)","description":"The details of the shipping option the method was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_option_id","type":"`string`","description":"The ID of the Shipping Option that the Shipping Method is built from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the shipping method is used in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the shipping method is used in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[ShippingMethodTaxLine](../../entities/classes/entities.ShippingMethodTaxLine.mdx)[]","description":"The details of the tax lines applied on the shipping method.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the shipping","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[{"name":"ARCHIVED","type":"`\"archived\"`","description":"The order is archived.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The order is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"COMPLETED","type":"`\"completed\"`","description":"The order is completed, meaning that\nthe items have been fulfilled and the payment\nhas been captured.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PENDING","type":"`\"pending\"`","description":"The order is pending.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUIRES_ACTION","type":"`\"requires_action\"`","description":"The order requires action.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"additional_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the new products to send to the customer, represented as line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"If true, swaps can be completed with items out of stock","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Swap was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the Swap was confirmed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[SwapFulfillmentStatus](../../entities/enums/entities.SwapFulfillmentStatus.mdx)","description":"The status of the Fulfillment of the Swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments that are used to send the new items to the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The swap's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the swap in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true, no notification will be sent related to this swap","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the additional payment authorized by the customer when `difference\\_due` is positive.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_status","type":"[SwapPaymentStatus](../../entities/enums/entities.SwapPaymentStatus.mdx)","description":"The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](../../entities/classes/entities.Return.mdx)","description":"The details of the return that belongs to the swap, which holds the details on the items being returned.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address that the new items should be sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used to fulfill the additional items purchased.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[{"name":"adjustments","type":"[LineItemAdjustment](../../entities/classes/entities.LineItemAdjustment.mdx)[]","description":"The details of the item's adjustments, which are available when a discount is applied on the item.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_discounts","type":"`boolean`","description":"Flag to indicate if the Line Item should be included when doing discount calculations.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claim_order","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)","description":"The details of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"claim_order_id","type":"`string`","description":"The ID of the claim that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"A more detailed description of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfilled_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been fulfilled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"has_shipping","type":"`null` \\| `boolean`","description":"Flag to indicate if the Line Item has fulfillment associated with it.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The line item's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Indicates if the line item unit\\_price include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"is_giftcard","type":"`boolean`","description":"Flag to indicate if the Line Item is a Gift Card.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_return","type":"`boolean`","description":"Is the item being returned","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[{"name":"carts","type":"[Cart](../../entities/classes/entities.Cart.mdx)[]","description":"The associated carts.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"The description of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The sales channel's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_disabled","type":"`boolean`","description":"Specify if the sales channel is enabled or disabled.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"locations","type":"[SalesChannelLocation](../../entities/classes/entities.SalesChannelLocation.mdx)[]","description":"The details of the stock locations related to the sales channel.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the sales channel.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The associated orders.","optional":false,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]},{"name":"products","type":"[Product](../../entities/classes/entities.Product.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"publishableKeys","type":"[PublishableApiKey](../../entities/classes/entities.PublishableApiKey.mdx)[]","description":"The associated publishable API keys.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### removeLineItem @@ -203,9 +193,7 @@ medusa.admin.draftOrders.removeLineItem(draftOrderId, itemId) #### Returns -`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### retrieve @@ -229,9 +217,7 @@ medusa.admin.draftOrders.retrieve(draftOrderId) #### Returns -`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### update @@ -253,13 +239,11 @@ medusa.admin.draftOrders.update(draftOrderId, { #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### updateLineItem @@ -281,8 +265,8 @@ medusa.admin.draftOrders.updateLineItem(draftOrderId, lineId, { #### Parameters -`","description":"The optional key-value map with additional details about the Line Item.","optional":true,"defaultValue":"{}","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the line item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the line item if `variant\\_id` is not provided.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The custom price of the line item. If a `variant\\_id` is supplied, the price provided here will override the variant's price.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"The optional key-value map with additional details about the Line Item.","optional":true,"defaultValue":"{}","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the draft order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"completed_at","type":"`Date`","description":"The date the draft order was completed at.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`number`","description":"The draft order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The draft order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification_order","type":"`boolean`","description":"Whether to send the customer notifications regarding order updates.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order created from the draft order when its payment is captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[DraftOrderStatus](../../entities/enums/entities.DraftOrderStatus.mdx)","description":"The status of the draft order. It's changed to `completed` when it's transformed to an order.","optional":false,"defaultValue":"open","expandable":false,"children":[{"name":"COMPLETED","type":"`\"completed\"`","description":"The draft order is completed, and an order has been created from it.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OPEN","type":"`\"open\"`","description":"The draft order is open.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminGiftCardsResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminGiftCardsResource.mdx index 8c3c239d79..072de612ae 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminGiftCardsResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminGiftCardsResource.mdx @@ -39,13 +39,11 @@ medusa.admin.giftCards.create({ #### Parameters -`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value (excluding VAT) that the Gift Card should represent.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The gift card's tax rate that will be applied on calculating totals","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The gift card's tax rate that will be applied on calculating totals","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### delete @@ -69,9 +67,7 @@ medusa.admin.giftCards.delete(giftCardId) #### Returns - - -___ + ### list @@ -112,9 +108,7 @@ medusa.admin.giftCards.list({ #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The gift card's tax rate that will be applied on calculating totals","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The gift card's tax rate that will be applied on calculating totals","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### retrieve @@ -138,9 +132,7 @@ medusa.admin.giftCards.retrieve(giftCardId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The gift card's tax rate that will be applied on calculating totals","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The gift card's tax rate that will be applied on calculating totals","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### update @@ -162,8 +154,8 @@ medusa.admin.giftCards.update(giftCardId, { #### Parameters -`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the Region in which the Gift Card can be used.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The gift card's tax rate that will be applied on calculating totals","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the gift card was purchased in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this gift card is available in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The gift card's tax rate that will be applied on calculating totals","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`number`","description":"The value that the Gift Card represents.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminInventoryItemsResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminInventoryItemsResource.mdx index 4fe2b69026..f971f95a97 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminInventoryItemsResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminInventoryItemsResource.mdx @@ -39,13 +39,11 @@ medusa.admin.inventoryItems.create({ #### Parameters -`","description":"An optional set of key-value pairs with additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string`","description":"The unique SKU of the associated Product Variant.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string`","description":"The inventory item's thumbnail.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The inventory item's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminPostInventoryItemsParams](../../medusa/classes/medusa.AdminPostInventoryItemsParams.mdx)","description":"Configurations to apply on the retrieved inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs with additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminPostInventoryItemsParams](../../medusa/classes/medusa.AdminPostInventoryItemsParams.mdx)","description":"Configurations to apply on the retrieved inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### createLocationLevel @@ -72,9 +70,7 @@ medusa.admin.inventoryItems.createLocationLevel(inventoryItemId, { #### Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### delete @@ -98,9 +94,7 @@ medusa.admin.inventoryItems.delete(inventoryItemId) #### Returns - - -___ + ### deleteLocationLevel @@ -124,9 +118,7 @@ medusa.admin.inventoryItems.deleteLocationLevel(inventoryItemId, locationId) #### Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### list @@ -164,13 +156,11 @@ medusa.admin.inventoryItems.list({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetInventoryItemsParams](../../medusa/classes/medusa.AdminGetInventoryItemsParams.mdx)","description":"Filters and pagination configurations applied on the retrieved inventory items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`number` \\| [NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator.mdx)","description":"Number filters to apply to inventory items' `height` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"String filters to apply to inventory items' `hs_code` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string` \\| `string`[]","description":"IDs to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`number` \\| [NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator.mdx)","description":"Number filters to apply to inventory items' `length` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[]","description":"Location IDs to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`string` \\| `string`[]","description":"Materials to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `string`[]","description":"MID codes to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `string`[]","description":"Origin countries to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search terms to search inventory items' sku, title, and description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Filter inventory items by whether they require shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[]","description":"SKUs to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| [NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator.mdx)","description":"Number filters to apply to inventory items' `weight` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| [NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator.mdx)","description":"Number filters to apply to inventory items' `width` field.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetInventoryItemsParams](../../medusa/classes/medusa.AdminGetInventoryItemsParams.mdx)","description":"Filters and pagination configurations applied on the retrieved inventory items.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string` \\| `string`[]","description":"IDs to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search terms to search inventory items' sku, title, and description.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string` \\| `string`[]","description":"Location IDs to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `string`[]","description":"SKUs to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `string`[]","description":"Origin countries to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `string`[]","description":"MID codes to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"material","type":"`string` \\| `string`[]","description":"Materials to filter inventory items by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`string` \\| `string`[] \\| [StringComparisonOperator](../../medusa/classes/medusa.StringComparisonOperator.mdx)","description":"String filters to apply to inventory items' `hs_code` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| [NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator.mdx)","description":"Number filters to apply to inventory items' `weight` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`number` \\| [NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator.mdx)","description":"Number filters to apply to inventory items' `length` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`number` \\| [NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator.mdx)","description":"Number filters to apply to inventory items' `height` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| [NumericalComparisonOperator](../../medusa/classes/medusa.NumericalComparisonOperator.mdx)","description":"Number filters to apply to inventory items' `width` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requires_shipping","type":"`boolean`","description":"Filter inventory items by whether they require shipping.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"the reserved stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"the total stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"An array of product variant details","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"allow_backorder","type":"`boolean`","description":"Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"A generic field for a GTIN number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"An EAN barcode number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product variant's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_items","type":"[ProductVariantInventoryItem](../../entities/classes/entities.ProductVariantInventoryItem.mdx)[]","description":"The details inventory items of the product variant.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"inventory_quantity","type":"`number`","description":"The current quantity of the item that is stocked.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether Medusa should manage inventory for the Product Variant.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValue](../../entities/classes/entities.ProductOptionValue.mdx)[]","description":"The details of the product options that this product variant defines values for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product","type":"[Product](../../entities/classes/entities.Product.mdx)","description":"The details of the product that the product variant belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the product that the product variant belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"A UPC barcode number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"The ranking of this variant","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"purchasable","type":"`boolean`","description":"Only used with the inventory modules.\nA boolean value indicating whether the Product Variant is purchasable.\nA variant is purchasable if:\n - inventory is not managed\n - it has no inventory items\n - it is in stock\n - it is backorderable.\n","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"An array of product variant details","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"allow_backorder","type":"`boolean`","description":"Whether the Product Variant should be purchasable when `inventory\\_quantity` is 0.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"barcode","type":"`null` \\| `string`","description":"A generic field for a GTIN number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ean","type":"`null` \\| `string`","description":"An EAN barcode number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"height","type":"`null` \\| `number`","description":"The height of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"hs_code","type":"`null` \\| `string`","description":"The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The product variant's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"inventory_items","type":"[ProductVariantInventoryItem](../../entities/classes/entities.ProductVariantInventoryItem.mdx)[]","description":"The details inventory items of the product variant.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"inventory_quantity","type":"`number`","description":"The current quantity of the item that is stocked.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"length","type":"`null` \\| `number`","description":"The length of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"manage_inventory","type":"`boolean`","description":"Whether Medusa should manage inventory for the Product Variant.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"material","type":"`null` \\| `string`","description":"The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`null` \\| `Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`null` \\| `string`","description":"The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ProductOptionValue](../../entities/classes/entities.ProductOptionValue.mdx)[]","description":"The details of the product options that this product variant defines values for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"origin_country","type":"`null` \\| `string`","description":"The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product","type":"[Product](../../entities/classes/entities.Product.mdx)","description":"The details of the product that the product variant belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"product_id","type":"`string`","description":"The ID of the product that the product variant belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`null` \\| `string`","description":"The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"A title that can be displayed for easy identification of the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"upc","type":"`null` \\| `string`","description":"A UPC barcode number that can be used to identify the Product Variant.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant_rank","type":"`null` \\| `number`","description":"The ranking of this variant","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"weight","type":"`null` \\| `number`","description":"The weight of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`null` \\| `number`","description":"The width of the Product Variant. May be used in shipping rate calculations.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"purchasable","type":"`boolean`","description":"Only used with the inventory modules.\nA boolean value indicating whether the Product Variant is purchasable.\nA variant is purchasable if:\n - inventory is not managed\n - it has no inventory items\n - it is in stock\n - it is backorderable.\n","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### listLocationLevels @@ -190,13 +180,11 @@ medusa.admin.inventoryItems.listLocationLevels(inventoryItemId) #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetInventoryItemsItemLocationLevelsParams](../../medusa/classes/medusa.AdminGetInventoryItemsItemLocationLevelsParams.mdx)","description":"Filters to apply on the retrieved location levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`[]","description":"Location IDs to filter location levels.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetInventoryItemsItemLocationLevelsParams](../../medusa/classes/medusa.AdminGetInventoryItemsItemLocationLevelsParams.mdx)","description":"Filters to apply on the retrieved location levels.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"location_id","type":"`string`[]","description":"Location IDs to filter location levels.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reserved_quantity","type":"`number`","description":"the reserved stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"stocked_quantity","type":"`number`","description":"the total stock quantity of an inventory item at the given location ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +` \\| `null`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`string` \\| `Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`string` \\| `Date` \\| `null`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### retrieve @@ -220,9 +208,7 @@ medusa.admin.inventoryItems.retrieve(inventoryItemId) #### Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### update @@ -244,13 +230,11 @@ medusa.admin.inventoryItems.update(inventoryItemId, { #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminPostInventoryItemsInventoryItemParams](../../medusa/classes/medusa.AdminPostInventoryItemsInventoryItemParams.mdx)","description":"Configurations to apply on the retrieved inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminPostInventoryItemsInventoryItemParams](../../medusa/classes/medusa.AdminPostInventoryItemsInventoryItemParams.mdx)","description":"Configurations to apply on the retrieved inventory item.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### updateLocationLevel @@ -276,4 +260,4 @@ medusa.admin.inventoryItems.updateLocationLevel(inventoryItemId, locationId, { #### Returns -` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"mid_code","type":"`string` \\| `null`","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.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"origin_country","type":"`string` \\| `null`","description":"The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sku","type":"`string` \\| `null`","description":"The Stock Keeping Unit (SKU) code of the Inventory Item.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"thumbnail","type":"`string` \\| `null`","description":"Thumbnail for the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string` \\| `null`","description":"Title of the inventory item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"weight","type":"`number` \\| `null`","description":"The weight of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"width","type":"`number` \\| `null`","description":"The width of the Inventory Item. May be used in shipping rate calculations.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +` \\| `null`","description":"An optional key-value map with additional details","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminInvitesResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminInvitesResource.mdx index 78fe995287..17ac5f33d7 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminInvitesResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminInvitesResource.mdx @@ -53,8 +53,6 @@ medusa.admin.invites.accept({ -___ - ### create Create an invite. This will generate a token associated with the invite and trigger an `invite.created` event. If you have a Notification Provider installed that handles this @@ -86,8 +84,6 @@ medusa.admin.invites.create({ -___ - ### delete Delete an invite. Only invites that weren't accepted can be deleted. @@ -110,9 +106,7 @@ medusa.admin.invites.delete(inviteId) #### Returns - - -___ + ### list @@ -136,9 +130,7 @@ medusa.admin.invites.list() #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't change the privileges of the user.","optional":false,"defaultValue":"member","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"token","type":"`string`","description":"The token used to accept the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_email","type":"`string`","description":"The email of the user being invited.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't change the privileges of the user.","optional":false,"defaultValue":"member","expandable":false,"children":[{"name":"ADMIN","type":"`\"admin\"`","description":"The user is an admin.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DEVELOPER","type":"`\"developer\"`","description":"The user is a developer.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"MEMBER","type":"`\"member\"`","description":"The user is a team member.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"token","type":"`string`","description":"The token used to accept the invite.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"user_email","type":"`string`","description":"The email of the user being invited.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### resend diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminNotesResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminNotesResource.mdx index fa9614df69..41406537ad 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminNotesResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminNotesResource.mdx @@ -42,9 +42,7 @@ medusa.admin.notes.create({ #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The note's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The note's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### delete @@ -68,9 +66,7 @@ medusa.admin.notes.delete(noteId) #### Returns - - -___ + ### list @@ -111,9 +107,7 @@ medusa.admin.notes.list({ #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The note's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The note's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### retrieve @@ -137,9 +131,7 @@ medusa.admin.notes.retrieve(noteId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The note's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The note's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### update @@ -165,4 +157,4 @@ medusa.admin.notes.update(noteId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The note's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"role","type":"[UserRoles](../../entities/enums/entities.UserRoles.mdx)","description":"The user's role. These roles don't provide any different privileges.","optional":false,"defaultValue":"member","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"author_id","type":"`string`","description":"The ID of the user that created the note.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The note's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Note refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"value","type":"`string`","description":"The contents of the note.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminNotificationsResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminNotificationsResource.mdx index 94bdef380a..da099038ce 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminNotificationsResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminNotificationsResource.mdx @@ -68,13 +68,11 @@ medusa.admin.notifications.list({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetNotificationsParams](../../medusa/classes/medusa.AdminGetNotificationsParams.mdx)","description":"Filters and pagination configurations applied to the retrieved notifications.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"event_name","type":"`string`","description":"Event name to filter notifications by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_resends","type":"`string`","description":"Whether to include resends in the results.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"50","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"Resource ID to filter notifications by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"Resource type to filter notifications by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"Filter notifications by their `to` field.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetNotificationsParams](../../medusa/classes/medusa.AdminGetNotificationsParams.mdx)","description":"Filters and pagination configurations applied to the retrieved notifications.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"50","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"Event name to filter notifications by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"Resource type to filter notifications by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_id","type":"`string`","description":"Resource ID to filter notifications by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"Filter notifications by their `to` field.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"include_resends","type":"`string`","description":"Whether to include resends in the results.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](../../entities/classes/entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](../../entities/classes/entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider","type":"[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)","description":"The notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resends","type":"[Notification](../../entities/classes/entities.Notification.mdx)[]","description":"The details of all resends of the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider","type":"[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)","description":"The notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the notification provider as given by the notification service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resends","type":"[Notification](../../entities/classes/entities.Notification.mdx)[]","description":"The details of all resends of the notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](../../entities/classes/entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider","type":"[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)","description":"The notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resends","type":"[Notification](../../entities/classes/entities.Notification.mdx)[]","description":"The details of all resends of the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](../../entities/classes/entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](../../entities/classes/entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider","type":"[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)","description":"The notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resends","type":"[Notification](../../entities/classes/entities.Notification.mdx)[]","description":"The details of all resends of the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider","type":"[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)","description":"The notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the notification provider as given by the notification service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resends","type":"[Notification](../../entities/classes/entities.Notification.mdx)[]","description":"The details of all resends of the notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](../../entities/classes/entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider","type":"[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)","description":"The notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resends","type":"[Notification](../../entities/classes/entities.Notification.mdx)[]","description":"The details of all resends of the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### resend @@ -98,4 +96,4 @@ medusa.admin.notifications.resend(notificationId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](../../entities/classes/entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](../../entities/classes/entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider","type":"[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)","description":"The notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resends","type":"[Notification](../../entities/classes/entities.Notification.mdx)[]","description":"The details of all resends of the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider","type":"[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)","description":"The notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the notification provider as given by the notification service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resends","type":"[Notification](../../entities/classes/entities.Notification.mdx)[]","description":"The details of all resends of the notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](../../entities/classes/entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider","type":"[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)","description":"The notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resends","type":"[Notification](../../entities/classes/entities.Notification.mdx)[]","description":"The details of all resends of the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"orders","type":"[Order](../../entities/classes/entities.Order.mdx)[]","description":"The details of the orders this customer placed.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"password_hash","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"phone","type":"`string`","description":"The customer's phone number","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_addresses","type":"[Address](../../entities/classes/entities.Address.mdx)[]","description":"The details of the shipping addresses associated with the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](../../entities/classes/entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](../../entities/classes/entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider","type":"[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)","description":"The notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resends","type":"[Notification](../../entities/classes/entities.Notification.mdx)[]","description":"The details of all resends of the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"provider","type":"[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)","description":"The notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"id","type":"`string`","description":"The ID of the notification provider as given by the notification service.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_installed","type":"`boolean`","description":"Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is\\_installed` attribute is set to `false`.","optional":false,"defaultValue":"true","expandable":false,"children":[]}]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resends","type":"[Notification](../../entities/classes/entities.Notification.mdx)[]","description":"The details of all resends of the notification.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`null` \\| `string`","description":"The ID of the customer that this notification was sent to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"event_name","type":"`string`","description":"The name of the event that the notification was sent for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The notification's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_id","type":"`string`","description":"The notification's parent ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"parent_notification","type":"[Notification](../../entities/classes/entities.Notification.mdx)","description":"The details of the parent notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider","type":"[NotificationProvider](../../entities/classes/entities.NotificationProvider.mdx)","description":"The notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the notification provider used to send the notification.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resends","type":"[Notification](../../entities/classes/entities.Notification.mdx)[]","description":"The details of all resends of the notification.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"resource_id","type":"`string`","description":"The ID of the resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"resource_type","type":"`string`","description":"The type of resource that the Notification refers to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"to","type":"`string`","description":"The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminOrderEditsResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminOrderEditsResource.mdx index c3430b938b..4805fbe49c 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminOrderEditsResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminOrderEditsResource.mdx @@ -40,13 +40,11 @@ medusa.admin.orderEdits.addLineItem(orderEditId, { #### Parameters -`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### cancel @@ -70,9 +68,7 @@ medusa.admin.orderEdits.cancel(orderEditId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### confirm @@ -96,9 +92,7 @@ medusa.admin.orderEdits.confirm(orderEditId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### create @@ -118,13 +112,11 @@ medusa.admin.orderEdits.create({ orderId }) #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### delete @@ -148,9 +140,7 @@ medusa.admin.orderEdits.delete(orderEditId) #### Returns - - -___ + ### deleteItemChange @@ -174,9 +164,7 @@ medusa.admin.orderEdits.deleteItemChange(orderEdit_id, itemChangeId) #### Returns - - -___ + ### list @@ -228,13 +216,11 @@ medusa.admin.orderEdits.list({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[GetOrderEditsParams](../../medusa/classes/medusa.GetOrderEditsParams.mdx)","description":"Filters and pagination configurations applied to retrieved order edits.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"Filter the order edits by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search order edits by their internal note.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[GetOrderEditsParams](../../medusa/classes/medusa.GetOrderEditsParams.mdx)","description":"Filters and pagination configurations applied to retrieved order edits.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"q","type":"`string`","description":"Search term to search order edits by their internal note.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_id","type":"`string`","description":"Filter the order edits by their associated order's ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### removeLineItem @@ -259,9 +245,7 @@ medusa.admin.orderEdits.removeLineItem(orderEditId, lineItemId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### requestConfirmation @@ -286,9 +270,7 @@ medusa.admin.orderEdits.requestConfirmation(orderEditId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### retrieve @@ -328,9 +310,7 @@ medusa.admin.orderEdits.retrieve(orderEditId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### update @@ -356,9 +336,7 @@ medusa.admin.orderEdits.update(orderEditId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### updateLineItem @@ -385,4 +363,4 @@ medusa.admin.orderEdits.updateLineItem(orderEditId, lineItemId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`null` \\| `string`","description":"The ID of the order that the line item may belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"product_id","type":"`null` \\| `string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"quantity","type":"`number`","description":"The quantity of the content in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returned_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipped_quantity","type":"`null` \\| `number`","description":"The quantity of the Line Item that has been shipped.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"should_merge","type":"`boolean`","description":"Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that the line item may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_lines","type":"[LineItemTaxLine](../../entities/classes/entities.LineItemTaxLine.mdx)[]","description":"The details of the item's tax lines.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"thumbnail","type":"`null` \\| `string`","description":"A URL string to a small image of the contents of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"The title of the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"unit_price","type":"`number`","description":"The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that this item was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`null` \\| `string`","description":"The id of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`null` \\| `number`","description":"The total of the gift card of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order_edit","type":"`null` \\| [OrderEdit](../../entities/classes/entities.OrderEdit.mdx)","description":"The details of the order edit.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"order_edit_id","type":"`null` \\| `string`","description":"The ID of the order edit that the item may belong to.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_item_id","type":"`null` \\| `string`","description":"The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_tax_total","type":"`null` \\| `number`","description":"The original tax total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"original_total","type":"`null` \\| `number`","description":"The original total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`null` \\| `number`","description":"The total of discount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable","type":"`null` \\| `number`","description":"The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`null` \\| `number`","description":"The subtotal of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`null` \\| `number`","description":"The total amount of the line item","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that this order edit was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that is edited","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_collection","type":"[PaymentCollection](../../entities/classes/entities.PaymentCollection.mdx)","description":"The details of the payment collection used to authorize additional payment if necessary.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"Amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"authorized_amount","type":"`null` \\| `number`","description":"Authorized amount of the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_by","type":"`string`","description":"The ID of the user that created the payment collection.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character ISO code for the currency this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`null` \\| `string`","description":"Description of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment collection's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_collection_id","type":"`string`","description":"The ID of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of the shipping amount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderEditStatus](../../entities/enums/entities.OrderEditStatus.mdx)","description":"The status of the order edit.","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"CANCELED","type":"`\"canceled\"`","description":"The order edit is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CONFIRMED","type":"`\"confirmed\"`","description":"The order edit is confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CREATED","type":"`\"created\"`","description":"The order edit is created.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DECLINED","type":"`\"declined\"`","description":"The order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REQUESTED","type":"`\"requested\"`","description":"The order edit is requested.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"subtotal","type":"`number`","description":"The total of subtotal","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the edited order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the edit was cancelled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_by","type":"`string`","description":"The unique identifier of the user or customer who cancelled the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the edit was confirmed.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_by","type":"`string`","description":"The unique identifier of the user or customer who confirmed the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_at","type":"`Date`","description":"The date with timezone at which the edit was declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_by","type":"`string`","description":"The unique identifier of the user or customer who declined the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"declined_reason","type":"`string`","description":"An optional note why the order edit is declined.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"internal_note","type":"`string`","description":"An optional note with additional details about the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_at","type":"`Date`","description":"The date with timezone at which the edit was requested.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"requested_by","type":"`string`","description":"The unique identifier of the user or customer who requested the order edit.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminOrdersResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminOrdersResource.mdx index 785df3ca56..c7166b7f56 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminOrdersResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminOrdersResource.mdx @@ -40,14 +40,12 @@ medusa.admin.orders.addShippingMethod(orderId, { #### Parameters -`","description":"The data required for the Shipping Option to create a Shipping Method. This depends on the Fulfillment Provider.","optional":true,"defaultValue":"{}","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"The data required for the Shipping Option to create a Shipping Method. This depends on the Fulfillment Provider.","optional":true,"defaultValue":"{}","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -___ - ### archive Archive an order and change its status. @@ -72,8 +70,6 @@ medusa.admin.orders.archive(orderId) -___ - ### cancel Cancel an order and change its status. This will also cancel any associated fulfillments and payments, and it may fail if the payment or fulfillment Provider @@ -99,8 +95,6 @@ medusa.admin.orders.cancel(orderId) -___ - ### cancelClaim Cancel a claim and change its status. A claim can't be canceled if it has a refund, if its fulfillments haven't been canceled, of if its associated return hasn't been canceled. @@ -125,8 +119,6 @@ medusa.admin.orders.cancelClaim(orderId, claimId) -___ - ### cancelClaimFulfillment Cancel a claim's fulfillment and change its fulfillment status to `canceled`. @@ -151,8 +143,6 @@ medusa.admin.orders.cancelClaimFulfillment(orderId, claimId, fulfillmentId) -___ - ### cancelFulfillment Cancel an order's fulfillment and change its fulfillment status to `canceled`. @@ -177,8 +167,6 @@ medusa.admin.orders.cancelFulfillment(orderId, fulfillmentId) -___ - ### cancelSwap Cancel a swap and change its status. @@ -203,8 +191,6 @@ medusa.admin.orders.cancelSwap(orderId, swapId) -___ - ### cancelSwapFulfillment Cancel a swap's fulfillment and change its fulfillment status to `canceled`. @@ -229,8 +215,6 @@ medusa.admin.orders.cancelSwapFulfillment(orderId, swapId, fulfillmentId) -___ - ### capturePayment Capture all the payments associated with an order. The payment of canceled orders can't be captured. @@ -255,8 +239,6 @@ medusa.admin.orders.capturePayment(orderId) -___ - ### complete Complete an order and change its status. A canceled order can't be completed. @@ -281,8 +263,6 @@ medusa.admin.orders.complete(orderId) -___ - ### createClaim Create a claim for an order. If a return shipping method is specified, a return will also be created and associated with the claim. If the claim's type is `refund`, @@ -310,14 +290,12 @@ medusa.admin.orders.createClaim(orderId, { #### Parameters -`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true no notification will be send related to this Claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refund_amount","type":"`number`","description":"The amount to refund the customer. This is used when the claim's type is `refund`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_location_id","type":"`string`","description":"The ID of the location used for the associated return.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"return_shipping","type":"[ReturnShipping](../../medusa/classes/medusa.ReturnShipping.mdx)","description":"Optional details for the Return Shipping Method, if the items are to be sent back. Providing this field will result in a return being created and associated with the claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[AddressPayload](../../medusa/classes/medusa.AddressPayload.mdx)","description":"An optional shipping address to send the claimed items to. If not provided, the parent order's shipping address will be used.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../medusa/classes/medusa.ShippingMethod-1.mdx)[]","description":"The Shipping Methods to send the additional Line Items with. This is only used if the claim's type is `replace`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -___ - ### createClaimShipment Create a shipment for the claim and mark its fulfillment as shipped. If the shipment is created successfully, this changes the claim's fulfillment status @@ -345,8 +323,6 @@ medusa.admin.orders.createClaimShipment(orderId, claimId, { -___ - ### createFulfillment Create a Fulfillment of an Order using the fulfillment provider, and change the order's fulfillment status to either `partially_fulfilled` or `fulfilled`, depending on @@ -373,14 +349,12 @@ medusa.admin.orders.createFulfillment(orderId, { #### Parameters -`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this fulfillment.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -___ - ### createShipment Create a shipment and mark a fulfillment as shipped. This changes the order's fulfillment status to either `partially_shipped` or `shipped`, depending on @@ -402,14 +376,12 @@ medusa.admin.orders.createShipment(order_id, { #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -___ - ### createSwap Create a swap for an order. This includes creating a return that is associated with the swap. @@ -435,14 +407,12 @@ medusa.admin.orders.createSwap(orderId, { #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -___ - ### createSwapShipment Create a shipment for a swap and mark its fulfillment as shipped. This changes the swap's fulfillment status to either `shipped` or `partially_shipped`, depending on @@ -464,14 +434,12 @@ medusa.admin.orders.createSwapShipment(orderId, swapId, { #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -___ - ### fulfillClaim Create a Fulfillment for a Claim, and change its fulfillment status to `partially_fulfilled` or `fulfilled` depending on whether all the items were fulfilled. @@ -492,14 +460,12 @@ medusa.admin.orders.fulfillClaim(orderId, claimId, { #### Parameters -`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this Claim.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this Claim.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the fulfillment's location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -___ - ### fulfillSwap Create a Fulfillment for a Swap and change its fulfillment status to `fulfilled`. If it requires any additional actions, @@ -521,14 +487,12 @@ medusa.admin.orders.fulfillSwap(orderId, swapId, { #### Parameters -`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this swap.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this swap.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"location_id","type":"`string`","description":"The ID of the fulfillment's location.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -___ - ### list Retrieve a list of orders. The orders can be filtered by fields such as `status` or `display_id` passed in the `query` parameter. The order can also be paginated. @@ -579,14 +543,12 @@ medusa.admin.orders.list({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetOrdersParams](../../medusa/classes/medusa.AdminGetOrdersParams.mdx)","description":"Filters and pagination configurations applied on the retrieved orders.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"50","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the orders' `canceled_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"Cart ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the orders' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"Currency code to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"Customer ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`string`","description":"Display ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"Email to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"`string`[]","description":"Fulfillment statuses to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"`string`[]","description":"Payment statuses to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search orders' shipping address, first name, email, and display ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[]","description":"Regions to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`[]","description":"Sales channel IDs to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`[]","description":"Statuses to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`string`","description":"Tax rate to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the orders' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetOrdersParams](../../medusa/classes/medusa.AdminGetOrdersParams.mdx)","description":"Filters and pagination configurations applied on the retrieved orders.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":false,"defaultValue":"50","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search orders' shipping address, first name, email, and display ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`[]","description":"Statuses to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"`string`[]","description":"Fulfillment statuses to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"`string`[]","description":"Payment statuses to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"display_id","type":"`string`","description":"Display ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"cart_id","type":"`string`","description":"Cart ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"Customer ID to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"Email to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`string` \\| `string`[]","description":"Regions to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"Currency code to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`string`","description":"Tax rate to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel_id","type":"`string`[]","description":"Sales channel IDs to filter orders by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the orders' `canceled_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the orders' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the orders' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -___ - ### processSwapPayment Process a swap's payment either by refunding or issuing a payment. This depends on the `difference_due` of the swap. If `difference_due` is negative, the amount is refunded. @@ -612,8 +574,6 @@ medusa.admin.orders.processSwapPayment(orderId, swapId) -___ - ### refundPayment Refund an amount for an order. The amount must be less than or equal the `refundable_amount` of the order. @@ -635,14 +595,12 @@ medusa.admin.orders.refundPayment(orderId, { #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -___ - ### requestReturn Request and create a return for items in an order. If the return shipping method is specified, it will be automatically fulfilled. @@ -668,14 +626,12 @@ medusa.admin.orders.requestReturn(orderId, { #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -___ - ### retrieve Retrieve an order's details. @@ -716,8 +672,6 @@ medusa.admin.orders.retrieve(orderId, { -___ - ### update Update an order's details. @@ -738,14 +692,12 @@ medusa.admin.orders.update(orderId, { #### Parameters -`[]","description":"The discounts applied to the order","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"`Record`[]","description":"The line items of the order","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_method","type":"[PaymentMethod](../../medusa/classes/medusa.PaymentMethod.mdx)","description":"The payment method chosen for the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"`string`","description":"ID of the region that the order is associated with.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[AddressPayload](../../medusa/classes/medusa.AddressPayload.mdx)","description":"The order's shipping address","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[ShippingMethod](../../medusa/classes/medusa.ShippingMethod-3.mdx)[]","description":"The Shipping Method used for shipping the order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`[]","description":"The line items of the order","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"region","type":"`string`","description":"ID of the region that the order is associated with.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"`Record`[]","description":"The discounts applied to the order","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_method","type":"[PaymentMethod](../../medusa/classes/medusa.PaymentMethod.mdx)","description":"The payment method chosen for the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_method","type":"[ShippingMethod](../../medusa/classes/medusa.ShippingMethod-3.mdx)[]","description":"The Shipping Method used for shipping the order.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to `true`, no notification will be sent to the customer related to this order.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -___ - ### updateClaim Update a claim's details. @@ -766,7 +718,7 @@ medusa.admin.orders.updateClaim(orderId, claimId, { #### Parameters -`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true no notification will be send related to this Swap.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../medusa/classes/medusa.ShippingMethod-2.mdx)[]","description":"The Shipping Methods to send the additional Line Items with.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional set of key-value pairs to hold additional information.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customHeaders","type":"`Record`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminPaymentCollectionsResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminPaymentCollectionsResource.mdx index 9d03c429b9..5ea4de3f91 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminPaymentCollectionsResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminPaymentCollectionsResource.mdx @@ -38,9 +38,7 @@ medusa.admin.paymentCollections.delete(paymentCollectionId) #### Returns - - -___ + ### markAsAuthorized @@ -64,9 +62,7 @@ medusa.admin.paymentCollections.markAsAuthorized(paymentCollectionId) #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment Session has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"The ID of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment session's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_initiated","type":"`boolean`","description":"A flag to indicate if a communication with the third party provider has been initiated.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_selected","type":"`null` \\| `boolean`","description":"A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the Payment Session was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the Payment Provider that is responsible for the Payment Session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires\\_more` to indicate that further actions are to be completed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount_refunded","type":"`number`","description":"The amount of the original Payment amount that has been refunded back to the Customer.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"AUTHORIZED","type":"`\"authorized\"`","description":"The payment colleciton is authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"AWAITING","type":"`\"awaiting\"`","description":"The payment collection is awaiting payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The payment collection is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_PAID","type":"`\"not_paid\"`","description":"The payment collection isn't paid.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_AUTHORIZED","type":"`\"partially_authorized\"`","description":"Some of the payments in the payment collection are authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment Session has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"The ID of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment session's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_initiated","type":"`boolean`","description":"A flag to indicate if a communication with the third party provider has been initiated.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_selected","type":"`null` \\| `boolean`","description":"A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the Payment Session was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the Payment Provider that is responsible for the Payment Session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires\\_more` to indicate that further actions are to be completed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount_refunded","type":"`number`","description":"The amount of the original Payment amount that has been refunded back to the Customer.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"AUTHORIZED","type":"`\"authorized\"`","description":"The payment colleciton is authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"AWAITING","type":"`\"awaiting\"`","description":"The payment collection is awaiting payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The payment collection is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_PAID","type":"`\"not_paid\"`","description":"The payment collection isn't paid.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_AUTHORIZED","type":"`\"partially_authorized\"`","description":"Some of the payments in the payment collection are authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### retrieve @@ -106,9 +102,7 @@ medusa.admin.paymentCollections.retrieve(paymentCollectionId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment Session has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"The ID of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment session's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_initiated","type":"`boolean`","description":"A flag to indicate if a communication with the third party provider has been initiated.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_selected","type":"`null` \\| `boolean`","description":"A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the Payment Session was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the Payment Provider that is responsible for the Payment Session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires\\_more` to indicate that further actions are to be completed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount_refunded","type":"`number`","description":"The amount of the original Payment amount that has been refunded back to the Customer.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"AUTHORIZED","type":"`\"authorized\"`","description":"The payment colleciton is authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"AWAITING","type":"`\"awaiting\"`","description":"The payment collection is awaiting payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The payment collection is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_PAID","type":"`\"not_paid\"`","description":"The payment collection isn't paid.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_AUTHORIZED","type":"`\"partially_authorized\"`","description":"Some of the payments in the payment collection are authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment Session has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"The ID of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment session's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_initiated","type":"`boolean`","description":"A flag to indicate if a communication with the third party provider has been initiated.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_selected","type":"`null` \\| `boolean`","description":"A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the Payment Session was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the Payment Provider that is responsible for the Payment Session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires\\_more` to indicate that further actions are to be completed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount_refunded","type":"`number`","description":"The amount of the original Payment amount that has been refunded back to the Customer.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"AUTHORIZED","type":"`\"authorized\"`","description":"The payment colleciton is authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"AWAITING","type":"`\"awaiting\"`","description":"The payment collection is awaiting payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The payment collection is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_PAID","type":"`\"not_paid\"`","description":"The payment collection isn't paid.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_AUTHORIZED","type":"`\"partially_authorized\"`","description":"Some of the payments in the payment collection are authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### update @@ -134,4 +128,4 @@ medusa.admin.paymentCollections.update(paymentCollectionId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment Session has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"The ID of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment session's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_initiated","type":"`boolean`","description":"A flag to indicate if a communication with the third party provider has been initiated.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_selected","type":"`null` \\| `boolean`","description":"A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the Payment Session was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the Payment Provider that is responsible for the Payment Session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires\\_more` to indicate that further actions are to be completed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount_refunded","type":"`number`","description":"The amount of the original Payment amount that has been refunded back to the Customer.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"AUTHORIZED","type":"`\"authorized\"`","description":"The payment colleciton is authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"AWAITING","type":"`\"awaiting\"`","description":"The payment collection is awaiting payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The payment collection is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_PAID","type":"`\"not_paid\"`","description":"The payment collection isn't paid.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_AUTHORIZED","type":"`\"partially_authorized\"`","description":"Some of the payments in the payment collection are authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of the payment sessions created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment Session has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`null` \\| `string`","description":"The ID of the cart that the payment session was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment session's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"is_initiated","type":"`boolean`","description":"A flag to indicate if a communication with the third party provider has been initiated.","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"is_selected","type":"`null` \\| `boolean`","description":"A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the Payment Session was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The ID of the Payment Provider that is responsible for the Payment Session","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"`string`","description":"Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires\\_more` to indicate that further actions are to be completed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments created as part of the payment collection.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount_refunded","type":"`number`","description":"The amount of the original Payment amount that has been refunded back to the Customer.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"automatic_taxes","type":"`boolean`","description":"Whether taxes should be automated in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"countries","type":"[Country](../../entities/classes/entities.Country.mdx)[]","description":"The details of the countries included in this region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The three character currency code used in the region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_providers","type":"[FulfillmentProvider](../../entities/classes/entities.FulfillmentProvider.mdx)[]","description":"The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards_taxable","type":"`boolean`","description":"Whether the gift cards are taxable or not in this region.","optional":false,"defaultValue":"true","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the prices for the region include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_providers","type":"[PaymentProvider](../../entities/classes/entities.PaymentProvider.mdx)[]","description":"The details of the payment providers that can be used to process payments in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_code","type":"`string`","description":"The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_provider","type":"[TaxProvider](../../entities/classes/entities.TaxProvider.mdx)","description":"The details of the tax provider used in the region.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_provider_id","type":"`null` \\| `string`","description":"The ID of the tax provider used in this region","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rate","type":"`number`","description":"The tax rate that should be charged on purchases in the Region.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_rates","type":"`null` \\| [TaxRate](../../entities/classes/entities.TaxRate.mdx)[]","description":"The details of the tax rates used in the region, aside from the default rate.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"region_id","type":"`string`","description":"The ID of the region this payment collection is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PaymentCollectionStatus](../../entities/enums/entities.PaymentCollectionStatus.mdx)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[{"name":"AUTHORIZED","type":"`\"authorized\"`","description":"The payment colleciton is authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"AWAITING","type":"`\"awaiting\"`","description":"The payment collection is awaiting payment.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"CANCELED","type":"`\"canceled\"`","description":"The payment collection is canceled.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"NOT_PAID","type":"`\"not_paid\"`","description":"The payment collection isn't paid.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PARTIALLY_AUTHORIZED","type":"`\"partially_authorized\"`","description":"Some of the payments in the payment collection are authorized.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[ORDER_EDIT](../../entities/enums/entities.PaymentCollectionType.mdx#order_edit)","description":"The type of the payment collection","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminPaymentsResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminPaymentsResource.mdx index 088760cfe9..4cb2253869 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminPaymentsResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminPaymentsResource.mdx @@ -38,9 +38,7 @@ medusa.admin.payments.capturePayment(paymentId) #### Returns -`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"additional_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the new products to send to the customer, represented as line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"If true, swaps can be completed with items out of stock","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Swap was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the Swap was confirmed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[SwapFulfillmentStatus](../../entities/enums/entities.SwapFulfillmentStatus.mdx)","description":"The status of the Fulfillment of the Swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments that are used to send the new items to the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The swap's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the swap in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true, no notification will be sent related to this swap","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the additional payment authorized by the customer when `difference\\_due` is positive.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_status","type":"[SwapPaymentStatus](../../entities/enums/entities.SwapPaymentStatus.mdx)","description":"The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](../../entities/classes/entities.Return.mdx)","description":"The details of the return that belongs to the swap, which holds the details on the items being returned.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address that the new items should be sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used to fulfill the additional items purchased.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"additional_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the new products to send to the customer, represented as line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"If true, swaps can be completed with items out of stock","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Swap was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the Swap was confirmed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[SwapFulfillmentStatus](../../entities/enums/entities.SwapFulfillmentStatus.mdx)","description":"The status of the Fulfillment of the Swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments that are used to send the new items to the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The swap's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the swap in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true, no notification will be sent related to this swap","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the additional payment authorized by the customer when `difference\\_due` is positive.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_status","type":"[SwapPaymentStatus](../../entities/enums/entities.SwapPaymentStatus.mdx)","description":"The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](../../entities/classes/entities.Return.mdx)","description":"The details of the return that belongs to the swap, which holds the details on the items being returned.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address that the new items should be sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used to fulfill the additional items purchased.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### refundPayment @@ -69,9 +67,7 @@ medusa.admin.payments.refundPayment(paymentId, { #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"An optional note explaining why the amount was refunded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order this refund was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order this refund was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the refund.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount_refunded","type":"`number`","description":"The amount of the original Payment amount that has been refunded back to the Customer.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_id","type":"`string`","description":"The payment's ID, if available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"`string`","description":"The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"note","type":"`string`","description":"An optional note explaining why the amount was refunded.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order this refund was created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order this refund was created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the refund.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount that the Payment has been authorized for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"amount_refunded","type":"`number`","description":"The amount of the original Payment amount that has been refunded back to the Customer.","optional":false,"defaultValue":"0","expandable":false,"children":[]},{"name":"canceled_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"captured_at","type":"`string` \\| `Date`","description":"The date with timezone at which the Payment was captured.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"payment_id","type":"`string`","description":"The payment's ID, if available.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"reason","type":"`string`","description":"The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### retrieve @@ -95,4 +91,4 @@ medusa.admin.payments.retrieve(paymentId) #### Returns -`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"additional_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the new products to send to the customer, represented as line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"If true, swaps can be completed with items out of stock","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Swap was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the Swap was confirmed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[SwapFulfillmentStatus](../../entities/enums/entities.SwapFulfillmentStatus.mdx)","description":"The status of the Fulfillment of the Swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments that are used to send the new items to the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The swap's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the swap in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true, no notification will be sent related to this swap","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the additional payment authorized by the customer when `difference\\_due` is positive.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_status","type":"[SwapPaymentStatus](../../entities/enums/entities.SwapPaymentStatus.mdx)","description":"The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](../../entities/classes/entities.Return.mdx)","description":"The details of the return that belongs to the swap, which holds the details on the items being returned.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address that the new items should be sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used to fulfill the additional items purchased.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"The context of the cart which can include info like IP or user agent.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer the cart belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The customer's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"An array of details of all discounts applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the cart","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"An array of details of all gift cards applied to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The cart's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a cart in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The line items added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"cart\"`","description":"","optional":false,"defaultValue":"\"cart\"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the payment associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_authorized_at","type":"`Date`","description":"The date with timezone at which the payment was authorized.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_id","type":"`string`","description":"The payment's ID if available","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_session","type":"`null` \\| [PaymentSession](../../entities/classes/entities.PaymentSession.mdx)","description":"The details of the selected payment session in the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_sessions","type":"[PaymentSession](../../entities/classes/entities.PaymentSession.mdx)[]","description":"The details of all payment sessions created on the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The sales channel ID the cart is associated with.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"`null` \\| [Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The shipping address's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods added to the cart.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"type","type":"[CartType](../../entities/enums/entities.CartType.mdx)","description":"The cart's type.","optional":false,"defaultValue":"default","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The total of items with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order associated with this cart is returned.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The total of shipping with taxes","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the cart","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency of the payment.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"code","type":"`string`","description":"The 3 character ISO code for the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The written name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`string`","description":"The symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`string`","description":"The native symbol used to indicate the currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the currency prices include tax","optional":true,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]}]},{"name":"currency_code","type":"`string`","description":"The 3 character ISO currency code of the payment.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"data","type":"`Record`","description":"The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The payment's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of a payment in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"billing_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the billing address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"billing_address_id","type":"`string`","description":"The ID of the billing address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date the order was canceled on.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"claims","type":"[ClaimOrder](../../entities/classes/entities.ClaimOrder.mdx)[]","description":"The details of the claims created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that is used in the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"customer","type":"[Customer](../../entities/classes/entities.Customer.mdx)","description":"The details of the customer associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"customer_id","type":"`string`","description":"The ID of the customer associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discount_total","type":"`number`","description":"The total of discount rounded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"discounts","type":"[Discount](../../entities/classes/entities.Discount.mdx)[]","description":"The details of the discounts applied on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"display_id","type":"`number`","description":"The order's display ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"draft_order","type":"[DraftOrder](../../entities/classes/entities.DraftOrder.mdx)","description":"The details of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"draft_order_id","type":"`string`","description":"The ID of the draft order this order was created from.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"edits","type":"[OrderEdit](../../entities/classes/entities.OrderEdit.mdx)[]","description":"The details of the order edits done on the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"email","type":"`string`","description":"The email associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"external_id","type":"`null` \\| `string`","description":"The ID of an external order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[FulfillmentStatus](../../entities/enums/entities.FulfillmentStatus.mdx)","description":"The order's fulfillment status","optional":false,"defaultValue":"not_fulfilled","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_card_tax_total","type":"`number`","description":"The total of gift cards with taxes","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_total","type":"`number`","description":"The total of gift cards","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"gift_card_transactions","type":"[GiftCardTransaction](../../entities/classes/entities.GiftCardTransaction.mdx)[]","description":"The gift card transactions made in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"gift_cards","type":"[GiftCard](../../entities/classes/entities.GiftCard.mdx)[]","description":"The details of the gift card used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The order's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the processing of the order in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"item_tax_total","type":"`null` \\| `number`","description":"The tax total applied on items","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that belong to the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"Flag for describing whether or not notifications related to this should be send.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"object","type":"`\"order\"`","description":"","optional":false,"defaultValue":"\"order\"","expandable":false,"children":[]},{"name":"paid_total","type":"`number`","description":"The total amount paid","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment_status","type":"[PaymentStatus](../../entities/enums/entities.PaymentStatus.mdx)","description":"The order's payment status","optional":false,"defaultValue":"not_paid","expandable":false,"children":[]},{"name":"payments","type":"[Payment](../../entities/classes/entities.Payment.mdx)[]","description":"The details of the payments used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"raw_discount_total","type":"`number`","description":"The total of discount","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refundable_amount","type":"`number`","description":"The amount that can be refunded","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunded_total","type":"`number`","description":"The total amount refunded if the order is returned.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"refunds","type":"[Refund](../../entities/classes/entities.Refund.mdx)[]","description":"The details of the refunds created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region this order was created in.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"region_id","type":"`string`","description":"The ID of the region this order was created in.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returns","type":"[Return](../../entities/classes/entities.Return.mdx)[]","description":"The details of the returns created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)","description":"The details of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channel_id","type":"`null` \\| `string`","description":"The ID of the sales channel this order belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address associated with the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The ID of the shipping address associated with the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used in the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_tax_total","type":"`null` \\| `number`","description":"The tax total applied on shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_total","type":"`number`","description":"The total of shipping","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[OrderStatus](../../entities/enums/entities.OrderStatus.mdx)","description":"The order's status","optional":false,"defaultValue":"pending","expandable":false,"children":[]},{"name":"subtotal","type":"`number`","description":"The subtotal of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swaps","type":"[Swap](../../entities/classes/entities.Swap.mdx)[]","description":"The details of the swaps created for the order.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"tax_rate","type":"`null` \\| `number`","description":"The order's tax rate","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"tax_total","type":"`null` \\| `number`","description":"The total of tax","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"total","type":"`number`","description":"The total amount of the order","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"returnable_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the line items that are returnable as part of the order, swaps, or claims","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"sales_channels","type":"[SalesChannel](../../entities/classes/entities.SalesChannel.mdx)[]","description":"The associated sales channels.","optional":true,"defaultValue":"","expandable":true,"featureFlag":"medusa_v2","children":[]}]},{"name":"order_id","type":"`string`","description":"The ID of the order that the payment session was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"provider_id","type":"`string`","description":"The id of the Payment Provider that is responsible for the Payment","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"swap","type":"[Swap](../../entities/classes/entities.Swap.mdx)","description":"The details of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"additional_items","type":"[LineItem](../../entities/classes/entities.LineItem.mdx)[]","description":"The details of the new products to send to the customer, represented as line items.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"allow_backorder","type":"`boolean`","description":"If true, swaps can be completed with items out of stock","optional":false,"defaultValue":"false","expandable":false,"children":[]},{"name":"canceled_at","type":"`Date`","description":"The date with timezone at which the Swap was canceled.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"cart","type":"[Cart](../../entities/classes/entities.Cart.mdx)","description":"The details of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"cart_id","type":"`string`","description":"The ID of the cart that the customer uses to complete the swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"confirmed_at","type":"`Date`","description":"The date with timezone at which the Swap was confirmed by the Customer.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"difference_due","type":"`number`","description":"The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillment_status","type":"[SwapFulfillmentStatus](../../entities/enums/entities.SwapFulfillmentStatus.mdx)","description":"The status of the Fulfillment of the Swap.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"fulfillments","type":"[Fulfillment](../../entities/classes/entities.Fulfillment.mdx)[]","description":"The details of the fulfillments that are used to send the new items to the customer.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"id","type":"`string`","description":"The swap's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"idempotency_key","type":"`string`","description":"Randomly generated key used to continue the completion of the swap in case of failure.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"metadata","type":"`Record`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"no_notification","type":"`boolean`","description":"If set to true, no notification will be sent related to this swap","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"[Order](../../entities/classes/entities.Order.mdx)","description":"The details of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"order_id","type":"`string`","description":"The ID of the order that the swap belongs to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"payment","type":"[Payment](../../entities/classes/entities.Payment.mdx)","description":"The details of the additional payment authorized by the customer when `difference\\_due` is positive.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"payment_status","type":"[SwapPaymentStatus](../../entities/enums/entities.SwapPaymentStatus.mdx)","description":"The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"return_order","type":"[Return](../../entities/classes/entities.Return.mdx)","description":"The details of the return that belongs to the swap, which holds the details on the items being returned.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address","type":"[Address](../../entities/classes/entities.Address.mdx)","description":"The details of the shipping address that the new items should be sent to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"shipping_address_id","type":"`string`","description":"The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"shipping_methods","type":"[ShippingMethod](../../entities/classes/entities.ShippingMethod.mdx)[]","description":"The details of the shipping methods used to fulfill the additional items purchased.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"swap_id","type":"`string`","description":"The ID of the swap that this payment was potentially created for.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> diff --git a/www/apps/docs/content/references/js_client/classes/js_client.AdminPriceListResource.mdx b/www/apps/docs/content/references/js_client/classes/js_client.AdminPriceListResource.mdx index 04eded50db..f87d9f1413 100644 --- a/www/apps/docs/content/references/js_client/classes/js_client.AdminPriceListResource.mdx +++ b/www/apps/docs/content/references/js_client/classes/js_client.AdminPriceListResource.mdx @@ -44,13 +44,11 @@ medusa.admin.priceLists.addPrices(priceListId, { #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](../../entities/classes/entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[{"name":"OVERRIDE","type":"`\"override\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"SALE","type":"`\"sale\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](../../entities/classes/entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[{"name":"SALE","type":"`\"sale\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OVERRIDE","type":"`\"override\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### create @@ -78,13 +76,11 @@ medusa.admin.priceLists.create({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](../../entities/classes/entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[{"name":"OVERRIDE","type":"`\"override\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"SALE","type":"`\"sale\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](../../entities/classes/entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[{"name":"SALE","type":"`\"sale\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OVERRIDE","type":"`\"override\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### delete @@ -108,9 +104,7 @@ medusa.admin.priceLists.delete(priceListId) #### Returns - - -___ + ### deletePrices @@ -138,9 +132,7 @@ medusa.admin.priceLists.deletePrices(priceListId, { #### Returns - - -___ + ### deleteProductPrices @@ -164,9 +156,7 @@ medusa.admin.priceLists.deleteProductPrices(priceListId, productId) #### Returns - - -___ + ### deleteProductsPrices @@ -195,9 +185,7 @@ medusa.admin.priceLists.deleteProductsPrices(priceListId, { #### Returns - - -___ + ### deleteVariantPrices @@ -221,9 +209,7 @@ medusa.admin.priceLists.deleteVariantPrices(priceListId, variantId) #### Returns - - -___ + ### list @@ -275,13 +261,11 @@ medusa.admin.priceLists.list({ #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetPriceListPaginationParams](../../medusa/classes/medusa.AdminGetPriceListPaginationParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved price lists.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the price lists' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"customer_groups","type":"`string`[]","description":"Filter price lists by their associated customer groups.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the price lists' `deleted_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"Description to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"IDs to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"10","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"Name to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search terms to search price lists' description, name, and customer group's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus.mdx)[]","description":"Statuses to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"The price list is active, meaning its prices are applied to customers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The price list is a draft, meaning its not yet applied to customers.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType.mdx)[]","description":"Types to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"OVERRIDE","type":"`\"override\"`","description":"The price list is used to override original prices for specific conditions.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"SALE","type":"`\"sale\"`","description":"The price list is used for a sale.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the price lists' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetPriceListPaginationParams](../../medusa/classes/medusa.AdminGetPriceListPaginationParams.mdx)","description":"Filters and pagination configurations to apply on the retrieved price lists.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of items returned in the list.","optional":true,"defaultValue":"10","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"IDs to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search terms to search price lists' description, name, and customer group's name.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus.mdx)[]","description":"Statuses to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"The price list is active, meaning its prices are applied to customers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"The price list is a draft, meaning its not yet applied to customers.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"name","type":"`string`","description":"Name to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"customer_groups","type":"`string`[]","description":"Filter price lists by their associated customer groups.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Description to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType.mdx)[]","description":"Types to filter price lists by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"SALE","type":"`\"sale\"`","description":"The price list is used for a sale.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OVERRIDE","type":"`\"override\"`","description":"The price list is used to override original prices for specific conditions.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the price lists' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the price lists' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the price lists' `deleted_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](../../entities/classes/entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[{"name":"OVERRIDE","type":"`\"override\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"SALE","type":"`\"sale\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> - -___ +`","description":"An optional key-value map with additional details","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`string`","description":"The name of the customer group","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_lists","type":"[PriceList](../../entities/classes/entities.PriceList.mdx)[]","description":"The price lists that are associated with the customer group.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"The price list's description","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"ends_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List stops being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The price list's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"includes_tax","type":"`boolean`","description":"Whether the price list prices include tax","optional":false,"defaultValue":"false","expandable":false,"featureFlag":"tax_inclusive_pricing","children":[]},{"name":"name","type":"`string`","description":"The price list's name","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"prices","type":"[MoneyAmount](../../entities/classes/entities.MoneyAmount.mdx)[]","description":"The prices that belong to the price list, represented as a Money Amount.","optional":false,"defaultValue":"","expandable":true,"children":[{"name":"amount","type":"`number`","description":"The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"`Date`","description":"The date with timezone at which the resource was created.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency_code","type":"`string`","description":"The 3 character currency code that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"deleted_at","type":"`null` \\| `Date`","description":"The date with timezone at which the resource was deleted.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"The money amount's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"max_quantity","type":"`null` \\| `number`","description":"The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"min_quantity","type":"`null` \\| `number`","description":"The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"price_list","type":"`null` \\| [PriceList](../../entities/classes/entities.PriceList.mdx)","description":"The details of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"price_list_id","type":"`null` \\| `string`","description":"The ID of the price list that the money amount may belong to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"region_id","type":"`null` \\| `string`","description":"The region's ID","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variant","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)","description":"The details of the product variant that the money amount may belong to.","optional":false,"defaultValue":"","expandable":true,"children":[]},{"name":"variant_id","type":"`string`","description":"The ID of the Product Variant contained in the Line Item.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"variants","type":"[ProductVariant](../../entities/classes/entities.ProductVariant.mdx)[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"currency","type":"[Currency](../../entities/classes/entities.Currency.mdx)","description":"The details of the currency that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]},{"name":"region","type":"[Region](../../entities/classes/entities.Region.mdx)","description":"The details of the region that the money amount may belong to.","optional":true,"defaultValue":"","expandable":true,"children":[]}]},{"name":"starts_at","type":"`null` \\| `Date`","description":"The date with timezone that the Price List starts being valid.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[PriceListStatus](../../medusa/enums/medusa.PriceListStatus-1.mdx)","description":"The status of the Price List","optional":false,"defaultValue":"draft","expandable":false,"children":[{"name":"ACTIVE","type":"`\"active\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"DRAFT","type":"`\"draft\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"type","type":"[PriceListType](../../medusa/enums/medusa.PriceListType-1.mdx)","description":"The type of Price List. This can be one of either `sale` or `override`.","optional":false,"defaultValue":"sale","expandable":false,"children":[{"name":"SALE","type":"`\"sale\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"OVERRIDE","type":"`\"override\"`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"`Date`","description":"The date with timezone at which the resource was updated.","optional":false,"defaultValue":"","expandable":false,"children":[]}]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> ### listProducts @@ -333,13 +317,11 @@ medusa.admin.priceLists.listProducts(priceListId, { #### Parameters -`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetPriceListsPriceListProductsParams](../../medusa/classes/medusa.AdminGetPriceListsPriceListProductsParams.mdx)","description":"Filters and pagination configurations applied on the retrieved products.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"collection_id","type":"`string`[]","description":"Filter products by their associated collection ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the products' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the products' `deleted_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"description","type":"`string`","description":"Description to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"Handle to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"id","type":"`string`","description":"ID to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`string`","description":"Filter products by whether they're gift cards.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of products returned in the list. Default is `50`.","optional":true,"defaultValue":"20","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search products' title, description, product variant's title and sku, and product collection's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)[]","description":"Statuses to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"DRAFT","type":"`\"draft\"`","description":"The product is a draft. It's not viewable by customers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROPOSED","type":"`\"proposed\"`","description":"The product is proposed, but not yet published.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PUBLISHED","type":"`\"published\"`","description":"The product is published.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REJECTED","type":"`\"rejected\"`","description":"The product is rejected. It's not viewable by customers.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"tags","type":"`string`[]","description":"Tags to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Title to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"Type to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the products' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> +`","description":"Custom headers to attach to the request.","optional":false,"defaultValue":"{}","expandable":false,"children":[]},{"name":"query","type":"[AdminGetPriceListsPriceListProductsParams](../../medusa/classes/medusa.AdminGetPriceListsPriceListProductsParams.mdx)","description":"Filters and pagination configurations applied on the retrieved products.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"id","type":"`string`","description":"ID to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"q","type":"`string`","description":"Search term to search products' title, description, product variant's title and sku, and product collection's title.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"status","type":"[ProductStatus](../../entities/enums/entities.ProductStatus.mdx)[]","description":"Statuses to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"DRAFT","type":"`\"draft\"`","description":"The product is a draft. It's not viewable by customers.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PROPOSED","type":"`\"proposed\"`","description":"The product is proposed, but not yet published.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"PUBLISHED","type":"`\"published\"`","description":"The product is published.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"REJECTED","type":"`\"rejected\"`","description":"The product is rejected. It's not viewable by customers.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"collection_id","type":"`string`[]","description":"Filter products by their associated collection ID.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"tags","type":"`string`[]","description":"Tags to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"title","type":"`string`","description":"Title to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"description","type":"`string`","description":"Description to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"handle","type":"`string`","description":"Handle to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"is_giftcard","type":"`string`","description":"Filter products by whether they're gift cards.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"type","type":"`string`","description":"Type to filter products by.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"order","type":"`string`","description":"The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"created_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the products' `created_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"updated_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the products' `updated_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"deleted_at","type":"[DateComparisonOperator](../../medusa/classes/medusa.DateComparisonOperator.mdx)","description":"Date filters to apply on the products' `deleted_at` date.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"lt","type":"`Date`","description":"The filtered date must be less than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gt","type":"`Date`","description":"The filtered date must be greater than this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"gte","type":"`Date`","description":"The filtered date must be greater than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"lte","type":"`Date`","description":"The filtered date must be less than or equal to this value.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"expand","type":"`string`","description":"Comma-separated relations that should be expanded in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"fields","type":"`string`","description":"Comma-separated fields that should be included in the returned data.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"offset","type":"`number`","description":"The number of items to skip when retrieving a list.","optional":true,"defaultValue":"0","expandable":false,"children":[]},{"name":"limit","type":"`number`","description":"Limit the number of products returned in the list. Default is `50`.","optional":true,"defaultValue":"20","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/js-client/overview#expanding-fields"/> #### Returns -